<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>PIL.OleFileIO — Pillow (PIL fork) 2.2.0 documentation</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.2.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="Pillow (PIL fork) 2.2.0 documentation" href="../../index.html" />
<link rel="up" title="Module code" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">Pillow (PIL fork) 2.2.0 documentation</a> »</li>
<li><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for PIL.OleFileIO</h1><div class="highlight"><pre>
<span class="c">#</span>
<span class="c"># THIS IS WORK IN PROGRESS</span>
<span class="c">#</span>
<span class="c"># The Python Imaging Library</span>
<span class="c"># $Id$</span>
<span class="c">#</span>
<span class="c"># stuff to deal with OLE2 Structured Storage files. this module is</span>
<span class="c"># used by PIL to read Image Composer and FlashPix files, but can also</span>
<span class="c"># be used to read other files of this type.</span>
<span class="c">#</span>
<span class="c"># History:</span>
<span class="c"># 1997-01-20 fl Created</span>
<span class="c"># 1997-01-22 fl Fixed 64-bit portability quirk</span>
<span class="c"># 2003-09-09 fl Fixed typo in OleFileIO.loadfat (noted by Daniel Haertle)</span>
<span class="c"># 2004-02-29 fl Changed long hex constants to signed integers</span>
<span class="c">#</span>
<span class="c"># Notes:</span>
<span class="c"># FIXME: sort out sign problem (eliminate long hex constants)</span>
<span class="c"># FIXME: change filename to use "a/b/c" instead of ["a", "b", "c"]</span>
<span class="c"># FIXME: provide a glob mechanism function (using fnmatchcase)</span>
<span class="c">#</span>
<span class="c"># Literature:</span>
<span class="c">#</span>
<span class="c"># "FlashPix Format Specification, Appendix A", Kodak and Microsoft,</span>
<span class="c"># September 1996.</span>
<span class="c">#</span>
<span class="c"># Quotes:</span>
<span class="c">#</span>
<span class="c"># "If this document and functionality of the Software conflict,</span>
<span class="c"># the actual functionality of the Software represents the correct</span>
<span class="c"># functionality" -- Microsoft, in the OLE format specification</span>
<span class="c">#</span>
<span class="c"># Copyright (c) Secret Labs AB 1997.</span>
<span class="c"># Copyright (c) Fredrik Lundh 1997.</span>
<span class="c">#</span>
<span class="c"># See the README file for information on usage and redistribution.</span>
<span class="c">#</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">print_function</span>
<span class="kn">import</span> <span class="nn">io</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">from</span> <span class="nn">PIL</span> <span class="kn">import</span> <span class="n">_binary</span>
<span class="kn">from</span> <span class="nn">PIL._util</span> <span class="kn">import</span> <span class="n">isPath</span>
<span class="k">if</span> <span class="nb">str</span> <span class="ow">is</span> <span class="ow">not</span> <span class="nb">bytes</span><span class="p">:</span>
<span class="nb">long</span> <span class="o">=</span> <span class="nb">int</span>
<span class="n">i8</span> <span class="o">=</span> <span class="n">_binary</span><span class="o">.</span><span class="n">i8</span>
<span class="n">i16</span> <span class="o">=</span> <span class="n">_binary</span><span class="o">.</span><span class="n">i16le</span>
<span class="n">i32</span> <span class="o">=</span> <span class="n">_binary</span><span class="o">.</span><span class="n">i32le</span>
<span class="n">MAGIC</span> <span class="o">=</span> <span class="n">b</span><span class="s">'</span><span class="se">\320\317\021\340\241\261\032\341</span><span class="s">'</span>
<span class="c">#</span>
<span class="c"># --------------------------------------------------------------------</span>
<span class="c"># property types</span>
<span class="n">VT_EMPTY</span><span class="o">=</span><span class="mi">0</span><span class="p">;</span> <span class="n">VT_NULL</span><span class="o">=</span><span class="mi">1</span><span class="p">;</span> <span class="n">VT_I2</span><span class="o">=</span><span class="mi">2</span><span class="p">;</span> <span class="n">VT_I4</span><span class="o">=</span><span class="mi">3</span><span class="p">;</span> <span class="n">VT_R4</span><span class="o">=</span><span class="mi">4</span><span class="p">;</span> <span class="n">VT_R8</span><span class="o">=</span><span class="mi">5</span><span class="p">;</span> <span class="n">VT_CY</span><span class="o">=</span><span class="mi">6</span><span class="p">;</span>
<span class="n">VT_DATE</span><span class="o">=</span><span class="mi">7</span><span class="p">;</span> <span class="n">VT_BSTR</span><span class="o">=</span><span class="mi">8</span><span class="p">;</span> <span class="n">VT_DISPATCH</span><span class="o">=</span><span class="mi">9</span><span class="p">;</span> <span class="n">VT_ERROR</span><span class="o">=</span><span class="mi">10</span><span class="p">;</span> <span class="n">VT_BOOL</span><span class="o">=</span><span class="mi">11</span><span class="p">;</span>
<span class="n">VT_VARIANT</span><span class="o">=</span><span class="mi">12</span><span class="p">;</span> <span class="n">VT_UNKNOWN</span><span class="o">=</span><span class="mi">13</span><span class="p">;</span> <span class="n">VT_DECIMAL</span><span class="o">=</span><span class="mi">14</span><span class="p">;</span> <span class="n">VT_I1</span><span class="o">=</span><span class="mi">16</span><span class="p">;</span> <span class="n">VT_UI1</span><span class="o">=</span><span class="mi">17</span><span class="p">;</span>
<span class="n">VT_UI2</span><span class="o">=</span><span class="mi">18</span><span class="p">;</span> <span class="n">VT_UI4</span><span class="o">=</span><span class="mi">19</span><span class="p">;</span> <span class="n">VT_I8</span><span class="o">=</span><span class="mi">20</span><span class="p">;</span> <span class="n">VT_UI8</span><span class="o">=</span><span class="mi">21</span><span class="p">;</span> <span class="n">VT_INT</span><span class="o">=</span><span class="mi">22</span><span class="p">;</span> <span class="n">VT_UINT</span><span class="o">=</span><span class="mi">23</span><span class="p">;</span>
<span class="n">VT_VOID</span><span class="o">=</span><span class="mi">24</span><span class="p">;</span> <span class="n">VT_HRESULT</span><span class="o">=</span><span class="mi">25</span><span class="p">;</span> <span class="n">VT_PTR</span><span class="o">=</span><span class="mi">26</span><span class="p">;</span> <span class="n">VT_SAFEARRAY</span><span class="o">=</span><span class="mi">27</span><span class="p">;</span> <span class="n">VT_CARRAY</span><span class="o">=</span><span class="mi">28</span><span class="p">;</span>
<span class="n">VT_USERDEFINED</span><span class="o">=</span><span class="mi">29</span><span class="p">;</span> <span class="n">VT_LPSTR</span><span class="o">=</span><span class="mi">30</span><span class="p">;</span> <span class="n">VT_LPWSTR</span><span class="o">=</span><span class="mi">31</span><span class="p">;</span> <span class="n">VT_FILETIME</span><span class="o">=</span><span class="mi">64</span><span class="p">;</span>
<span class="n">VT_BLOB</span><span class="o">=</span><span class="mi">65</span><span class="p">;</span> <span class="n">VT_STREAM</span><span class="o">=</span><span class="mi">66</span><span class="p">;</span> <span class="n">VT_STORAGE</span><span class="o">=</span><span class="mi">67</span><span class="p">;</span> <span class="n">VT_STREAMED_OBJECT</span><span class="o">=</span><span class="mi">68</span><span class="p">;</span>
<span class="n">VT_STORED_OBJECT</span><span class="o">=</span><span class="mi">69</span><span class="p">;</span> <span class="n">VT_BLOB_OBJECT</span><span class="o">=</span><span class="mi">70</span><span class="p">;</span> <span class="n">VT_CF</span><span class="o">=</span><span class="mi">71</span><span class="p">;</span> <span class="n">VT_CLSID</span><span class="o">=</span><span class="mi">72</span><span class="p">;</span>
<span class="n">VT_VECTOR</span><span class="o">=</span><span class="mh">0x1000</span><span class="p">;</span>
<span class="c"># map property id to name (for debugging purposes)</span>
<span class="n">VT</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="nb">vars</span><span class="p">()</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span>
<span class="k">if</span> <span class="n">k</span><span class="p">[:</span><span class="mi">3</span><span class="p">]</span> <span class="o">==</span> <span class="s">"VT_"</span><span class="p">:</span>
<span class="n">VT</span><span class="p">[</span><span class="n">v</span><span class="p">]</span> <span class="o">=</span> <span class="n">k</span>
<span class="c">#</span>
<span class="c"># --------------------------------------------------------------------</span>
<span class="c"># Some common document types (root.clsid fields)</span>
<span class="n">WORD_CLSID</span> <span class="o">=</span> <span class="s">"00020900-0000-0000-C000-000000000046"</span>
<span class="c">#</span>
<span class="c"># --------------------------------------------------------------------</span>
<span class="k">class</span> <span class="nc">_OleStream</span><span class="p">(</span><span class="n">io</span><span class="o">.</span><span class="n">BytesIO</span><span class="p">):</span>
<span class="sd">"""OLE2 Stream</span>
<span class="sd"> Returns a read-only file object which can be used to read</span>
<span class="sd"> the contents of a OLE stream. To open a stream, use the</span>
<span class="sd"> openstream method in the OleFile class.</span>
<span class="sd"> This function can be used with either ordinary streams,</span>
<span class="sd"> or ministreams, depending on the offset, sectorsize, and</span>
<span class="sd"> fat table arguments.</span>
<span class="sd"> """</span>
<span class="c"># FIXME: should store the list of sects obtained by following</span>
<span class="c"># the fat chain, and load new sectors on demand instead of</span>
<span class="c"># loading it all in one go.</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fp</span><span class="p">,</span> <span class="n">sect</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">sectorsize</span><span class="p">,</span> <span class="n">fat</span><span class="p">):</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">while</span> <span class="n">sect</span> <span class="o">!=</span> <span class="o">-</span><span class="mi">2</span><span class="p">:</span> <span class="c"># 0xFFFFFFFEL:</span>
<span class="n">fp</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">offset</span> <span class="o">+</span> <span class="n">sectorsize</span> <span class="o">*</span> <span class="n">sect</span><span class="p">)</span>
<span class="n">data</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">sectorsize</span><span class="p">))</span>
<span class="n">sect</span> <span class="o">=</span> <span class="n">fat</span><span class="p">[</span><span class="n">sect</span><span class="p">]</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">b</span><span class="s">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="c"># print len(data), size</span>
<span class="n">io</span><span class="o">.</span><span class="n">BytesIO</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">[:</span><span class="n">size</span><span class="p">])</span>
<span class="c">#</span>
<span class="c"># --------------------------------------------------------------------</span>
<span class="c"># FIXME: should add a counter in here to avoid looping forever</span>
<span class="c"># if the tree is broken.</span>
<span class="k">class</span> <span class="nc">_OleDirectoryEntry</span><span class="p">:</span>
<span class="sd">"""OLE2 Directory Entry</span>
<span class="sd"> Encapsulates a stream directory entry. Note that the</span>
<span class="sd"> constructor builds a tree of all subentries, so we only</span>
<span class="sd"> have to call it with the root object.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sidlist</span><span class="p">,</span> <span class="n">sid</span><span class="p">):</span>
<span class="c"># store directory parameters. the caller provides</span>
<span class="c"># a complete list of directory entries, as read from</span>
<span class="c"># the directory stream.</span>
<span class="n">name</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">sect</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">sids</span><span class="p">,</span> <span class="n">clsid</span> <span class="o">=</span> <span class="n">sidlist</span><span class="p">[</span><span class="n">sid</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sid</span> <span class="o">=</span> <span class="n">sid</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="nb">type</span> <span class="c"># 1=storage 2=stream</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sect</span> <span class="o">=</span> <span class="n">sect</span>
<span class="bp">self</span><span class="o">.</span><span class="n">size</span> <span class="o">=</span> <span class="n">size</span>
<span class="bp">self</span><span class="o">.</span><span class="n">clsid</span> <span class="o">=</span> <span class="n">clsid</span>
<span class="c"># process child nodes, if any</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kids</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">sid</span> <span class="o">=</span> <span class="n">sidlist</span><span class="p">[</span><span class="n">sid</span><span class="p">][</span><span class="mi">4</span><span class="p">][</span><span class="mi">2</span><span class="p">]</span>
<span class="k">if</span> <span class="n">sid</span> <span class="o">!=</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
<span class="c"># the directory entries are organized as a red-black tree.</span>
<span class="c"># the following piece of code does an ordered traversal of</span>
<span class="c"># such a tree (at least that's what I hope ;-)</span>
<span class="n">stack</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">sid</span><span class="p">]</span>
<span class="c"># start at leftmost position</span>
<span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">,</span> <span class="n">child</span> <span class="o">=</span> <span class="n">sidlist</span><span class="p">[</span><span class="n">sid</span><span class="p">][</span><span class="mi">4</span><span class="p">]</span>
<span class="k">while</span> <span class="n">left</span> <span class="o">!=</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span> <span class="c"># 0xFFFFFFFFL:</span>
<span class="n">stack</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sid</span><span class="p">)</span>
<span class="n">sid</span> <span class="o">=</span> <span class="n">left</span>
<span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">,</span> <span class="n">child</span> <span class="o">=</span> <span class="n">sidlist</span><span class="p">[</span><span class="n">sid</span><span class="p">][</span><span class="mi">4</span><span class="p">]</span>
<span class="k">while</span> <span class="n">sid</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sid</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kids</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">_OleDirectoryEntry</span><span class="p">(</span><span class="n">sidlist</span><span class="p">,</span> <span class="n">sid</span><span class="p">))</span>
<span class="c"># try to move right</span>
<span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">,</span> <span class="n">child</span> <span class="o">=</span> <span class="n">sidlist</span><span class="p">[</span><span class="n">sid</span><span class="p">][</span><span class="mi">4</span><span class="p">]</span>
<span class="k">if</span> <span class="n">right</span> <span class="o">!=</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span> <span class="c"># 0xFFFFFFFFL:</span>
<span class="c"># and then back to the left</span>
<span class="n">sid</span> <span class="o">=</span> <span class="n">right</span>
<span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
<span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">,</span> <span class="n">child</span> <span class="o">=</span> <span class="n">sidlist</span><span class="p">[</span><span class="n">sid</span><span class="p">][</span><span class="mi">4</span><span class="p">]</span>
<span class="k">if</span> <span class="n">left</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span> <span class="c"># 0xFFFFFFFFL:</span>
<span class="k">break</span>
<span class="n">stack</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sid</span><span class="p">)</span>
<span class="n">sid</span> <span class="o">=</span> <span class="n">left</span>
<span class="k">else</span><span class="p">:</span>
<span class="c"># couldn't move right; move up instead</span>
<span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
<span class="n">ptr</span> <span class="o">=</span> <span class="n">stack</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">del</span> <span class="n">stack</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">,</span> <span class="n">child</span> <span class="o">=</span> <span class="n">sidlist</span><span class="p">[</span><span class="n">ptr</span><span class="p">][</span><span class="mi">4</span><span class="p">]</span>
<span class="k">if</span> <span class="n">right</span> <span class="o">!=</span> <span class="n">sid</span><span class="p">:</span>
<span class="k">break</span>
<span class="n">sid</span> <span class="o">=</span> <span class="n">right</span>
<span class="n">left</span><span class="p">,</span> <span class="n">right</span><span class="p">,</span> <span class="n">child</span> <span class="o">=</span> <span class="n">sidlist</span><span class="p">[</span><span class="n">sid</span><span class="p">][</span><span class="mi">4</span><span class="p">]</span>
<span class="k">if</span> <span class="n">right</span> <span class="o">!=</span> <span class="n">ptr</span><span class="p">:</span>
<span class="n">sid</span> <span class="o">=</span> <span class="n">ptr</span>
<span class="c"># in the OLE file, entries are sorted on (length, name).</span>
<span class="c"># for convenience, we sort them on name instead.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kids</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">__cmp__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="s">"Compare entries by name"</span>
<span class="k">return</span> <span class="nb">cmp</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tab</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
<span class="s">"Dump this entry, and all its subentries (for debug purposes only)"</span>
<span class="n">TYPES</span> <span class="o">=</span> <span class="p">[</span><span class="s">"(invalid)"</span><span class="p">,</span> <span class="s">"(storage)"</span><span class="p">,</span> <span class="s">"(stream)"</span><span class="p">,</span> <span class="s">"(lockbytes)"</span><span class="p">,</span>
<span class="s">"(property)"</span><span class="p">,</span> <span class="s">"(root)"</span><span class="p">]</span>
<span class="k">print</span><span class="p">(</span><span class="s">" "</span><span class="o">*</span><span class="n">tab</span> <span class="o">+</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">),</span> <span class="n">TYPES</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">],</span> <span class="n">end</span><span class="o">=</span><span class="s">' '</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="ow">in</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">5</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">size</span><span class="p">,</span> <span class="s">"bytes"</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s">' '</span><span class="p">)</span>
<span class="k">print</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="ow">in</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">clsid</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="s">" "</span><span class="o">*</span><span class="n">tab</span> <span class="o">+</span> <span class="s">"{</span><span class="si">%s</span><span class="s">}"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">clsid</span><span class="p">)</span>
<span class="k">for</span> <span class="n">kid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">kids</span><span class="p">:</span>
<span class="n">kid</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="n">tab</span> <span class="o">+</span> <span class="mi">2</span><span class="p">)</span>
<span class="c">#</span>
<span class="c"># --------------------------------------------------------------------</span>
<span class="c">##</span>
<span class="c"># This class encapsulates the interface to an OLE 2 structured</span>
<span class="c"># storage file. Use the {@link listdir} and {@link openstream}</span>
<span class="c"># methods to access the contents of this file.</span>
<div class="viewcode-block" id="OleFileIO"><a class="viewcode-back" href="../../PIL.html#PIL.OleFileIO.OleFileIO">[docs]</a><span class="k">class</span> <span class="nc">OleFileIO</span><span class="p">:</span>
<span class="sd">"""OLE container object</span>
<span class="sd"> This class encapsulates the interface to an OLE 2 structured</span>
<span class="sd"> storage file. Use the listdir and openstream methods to access</span>
<span class="sd"> the contents of this file.</span>
<span class="sd"> Object names are given as a list of strings, one for each subentry</span>
<span class="sd"> level. The root entry should be omitted. For example, the following</span>
<span class="sd"> code extracts all image streams from a Microsoft Image Composer file::</span>
<span class="sd"> ole = OleFileIO("fan.mic")</span>
<span class="sd"> for entry in ole.listdir():</span>
<span class="sd"> if entry[1:2] == "Image":</span>
<span class="sd"> fin = ole.openstream(entry)</span>
<span class="sd"> fout = open(entry[0:1], "wb")</span>
<span class="sd"> while 1:</span>
<span class="sd"> s = fin.read(8192)</span>
<span class="sd"> if not s:</span>
<span class="sd"> break</span>
<span class="sd"> fout.write(s)</span>
<span class="sd"> You can use the viewer application provided with the Python Imaging</span>
<span class="sd"> Library to view the resulting files (which happens to be standard</span>
<span class="sd"> TIFF files).</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
<span class="k">if</span> <span class="n">filename</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
<span class="c">##</span>
<span class="c"># Open an OLE2 file.</span>
<div class="viewcode-block" id="OleFileIO.open"><a class="viewcode-back" href="../../PIL.html#PIL.OleFileIO.OleFileIO.open">[docs]</a> <span class="k">def</span> <span class="nf">open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="sd">"""Open an OLE2 file"""</span>
<span class="k">if</span> <span class="n">isPath</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fp</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s">"rb"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fp</span> <span class="o">=</span> <span class="n">filename</span>
<span class="n">header</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">512</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">header</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">512</span> <span class="ow">or</span> <span class="n">header</span><span class="p">[:</span><span class="mi">8</span><span class="p">]</span> <span class="o">!=</span> <span class="n">MAGIC</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"not an OLE2 structured storage file"</span><span class="p">)</span>
<span class="c"># file clsid (probably never used, so we don't store it)</span>
<span class="n">clsid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_clsid</span><span class="p">(</span><span class="n">header</span><span class="p">[</span><span class="mi">8</span><span class="p">:</span><span class="mi">24</span><span class="p">])</span>
<span class="c"># FIXME: could check version and byte order fields</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sectorsize</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="n">i16</span><span class="p">(</span><span class="n">header</span><span class="p">,</span> <span class="mi">30</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">minisectorsize</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="n">i16</span><span class="p">(</span><span class="n">header</span><span class="p">,</span> <span class="mi">32</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">minisectorcutoff</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">header</span><span class="p">,</span> <span class="mi">56</span><span class="p">)</span>
<span class="c"># Load file allocation tables</span>
<span class="bp">self</span><span class="o">.</span><span class="n">loadfat</span><span class="p">(</span><span class="n">header</span><span class="p">)</span>
<span class="c"># Load direcory. This sets both the sidlist (ordered by id)</span>
<span class="c"># and the root (ordered by hierarchy) members.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">loaddirectory</span><span class="p">(</span><span class="n">i32</span><span class="p">(</span><span class="n">header</span><span class="p">,</span> <span class="mi">48</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ministream</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">minifatsect</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">header</span><span class="p">,</span> <span class="mi">60</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="OleFileIO.loadfat"><a class="viewcode-back" href="../../PIL.html#PIL.OleFileIO.OleFileIO.loadfat">[docs]</a> <span class="k">def</span> <span class="nf">loadfat</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">):</span>
<span class="c"># Load the FAT table. The header contains a sector numbers</span>
<span class="c"># for the first 109 FAT sectors. Additional sectors are</span>
<span class="c"># described by DIF blocks (FIXME: not yet implemented)</span>
<span class="n">sect</span> <span class="o">=</span> <span class="n">header</span><span class="p">[</span><span class="mi">76</span><span class="p">:</span><span class="mi">512</span><span class="p">]</span>
<span class="n">fat</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">sect</span><span class="p">),</span> <span class="mi">4</span><span class="p">):</span>
<span class="n">ix</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">sect</span><span class="p">,</span> <span class="n">i</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ix</span> <span class="o">==</span> <span class="o">-</span><span class="mi">2</span> <span class="ow">or</span> <span class="n">ix</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span> <span class="c"># ix == 0xFFFFFFFEL or ix == 0xFFFFFFFFL:</span>
<span class="k">break</span>
<span class="n">s</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getsect</span><span class="p">(</span><span class="n">ix</span><span class="p">)</span>
<span class="n">fat</span> <span class="o">=</span> <span class="n">fat</span> <span class="o">+</span> <span class="p">[</span><span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">),</span> <span class="mi">4</span><span class="p">)]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fat</span> <span class="o">=</span> <span class="n">fat</span>
</div>
<div class="viewcode-block" id="OleFileIO.loadminifat"><a class="viewcode-back" href="../../PIL.html#PIL.OleFileIO.OleFileIO.loadminifat">[docs]</a> <span class="k">def</span> <span class="nf">loadminifat</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c"># Load the MINIFAT table. This is stored in a standard sub-</span>
<span class="c"># stream, pointed to by a header field.</span>
<span class="n">s</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">minifatsect</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">minifat</span> <span class="o">=</span> <span class="p">[</span><span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">),</span> <span class="mi">4</span><span class="p">)]</span>
</div>
<div class="viewcode-block" id="OleFileIO.getsect"><a class="viewcode-back" href="../../PIL.html#PIL.OleFileIO.OleFileIO.getsect">[docs]</a> <span class="k">def</span> <span class="nf">getsect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sect</span><span class="p">):</span>
<span class="c"># Read given sector</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fp</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">512</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">sectorsize</span> <span class="o">*</span> <span class="n">sect</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sectorsize</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">_unicode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="c"># Map unicode string to Latin 1</span>
<span class="k">if</span> <span class="nb">bytes</span> <span class="ow">is</span> <span class="nb">str</span><span class="p">:</span>
<span class="c"># Old version tried to produce a Latin-1 str</span>
<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'utf-16'</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">'latin-1'</span><span class="p">,</span> <span class="s">'replace'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c"># Provide actual Unicode string</span>
<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'utf-16'</span><span class="p">)</span>
<div class="viewcode-block" id="OleFileIO.loaddirectory"><a class="viewcode-back" href="../../PIL.html#PIL.OleFileIO.OleFileIO.loaddirectory">[docs]</a> <span class="k">def</span> <span class="nf">loaddirectory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sect</span><span class="p">):</span>
<span class="c"># Load the directory. The directory is stored in a standard</span>
<span class="c"># substream, independent of its size.</span>
<span class="c"># read directory stream</span>
<span class="n">fp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="n">sect</span><span class="p">)</span>
<span class="c"># create list of sid entries</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sidlist</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
<span class="n">entry</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">128</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">break</span>
<span class="nb">type</span> <span class="o">=</span> <span class="n">i8</span><span class="p">(</span><span class="n">entry</span><span class="p">[</span><span class="mi">66</span><span class="p">])</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_unicode</span><span class="p">(</span><span class="n">entry</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">0</span><span class="o">+</span><span class="n">i16</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="mi">64</span><span class="p">)])</span>
<span class="n">ptrs</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="mi">68</span><span class="p">),</span> <span class="n">i32</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="mi">72</span><span class="p">),</span> <span class="n">i32</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="mi">76</span><span class="p">)</span>
<span class="n">sect</span><span class="p">,</span> <span class="n">size</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="mi">116</span><span class="p">),</span> <span class="n">i32</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="mi">120</span><span class="p">)</span>
<span class="n">clsid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_clsid</span><span class="p">(</span><span class="n">entry</span><span class="p">[</span><span class="mi">80</span><span class="p">:</span><span class="mi">96</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sidlist</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">name</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">sect</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">ptrs</span><span class="p">,</span> <span class="n">clsid</span><span class="p">))</span>
<span class="c"># create hierarchical list of directory entries</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">=</span> <span class="n">_OleDirectoryEntry</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sidlist</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="OleFileIO.dumpdirectory"><a class="viewcode-back" href="../../PIL.html#PIL.OleFileIO.OleFileIO.dumpdirectory">[docs]</a> <span class="k">def</span> <span class="nf">dumpdirectory</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c"># Dump directory (for debugging only)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">dump</span><span class="p">()</span>
</div>
<span class="k">def</span> <span class="nf">_clsid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">clsid</span><span class="p">):</span>
<span class="k">if</span> <span class="n">clsid</span> <span class="o">==</span> <span class="s">"</span><span class="se">\0</span><span class="s">"</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">clsid</span><span class="p">):</span>
<span class="k">return</span> <span class="s">""</span>
<span class="k">return</span> <span class="p">((</span><span class="s">"</span><span class="si">%08X</span><span class="s">-</span><span class="si">%04X</span><span class="s">-</span><span class="si">%04X</span><span class="s">-</span><span class="si">%02X%02X</span><span class="s">-"</span> <span class="o">+</span> <span class="s">"</span><span class="si">%02X</span><span class="s">"</span> <span class="o">*</span> <span class="mi">6</span><span class="p">)</span> <span class="o">%</span>
<span class="p">((</span><span class="n">i32</span><span class="p">(</span><span class="n">clsid</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">i16</span><span class="p">(</span><span class="n">clsid</span><span class="p">,</span> <span class="mi">4</span><span class="p">),</span> <span class="n">i16</span><span class="p">(</span><span class="n">clsid</span><span class="p">,</span> <span class="mi">6</span><span class="p">))</span> <span class="o">+</span>
<span class="nb">tuple</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="n">i8</span><span class="p">,</span> <span class="n">clsid</span><span class="p">[</span><span class="mi">8</span><span class="p">:</span><span class="mi">16</span><span class="p">]))))</span>
<span class="k">def</span> <span class="nf">_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">files</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">node</span><span class="p">):</span>
<span class="c"># listdir helper</span>
<span class="n">prefix</span> <span class="o">=</span> <span class="n">prefix</span> <span class="o">+</span> <span class="p">[</span><span class="n">node</span><span class="o">.</span><span class="n">name</span><span class="p">]</span>
<span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">node</span><span class="o">.</span><span class="n">kids</span><span class="p">:</span>
<span class="k">if</span> <span class="n">entry</span><span class="o">.</span><span class="n">kids</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_list</span><span class="p">(</span><span class="n">files</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">entry</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">files</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">prefix</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="o">+</span> <span class="p">[</span><span class="n">entry</span><span class="o">.</span><span class="n">name</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">_find</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="c"># openstream helper</span>
<span class="n">node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">root</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">filename</span><span class="p">:</span>
<span class="k">for</span> <span class="n">kid</span> <span class="ow">in</span> <span class="n">node</span><span class="o">.</span><span class="n">kids</span><span class="p">:</span>
<span class="k">if</span> <span class="n">kid</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">name</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"file not found"</span><span class="p">)</span>
<span class="n">node</span> <span class="o">=</span> <span class="n">kid</span>
<span class="k">return</span> <span class="n">node</span><span class="o">.</span><span class="n">sid</span>
<span class="k">def</span> <span class="nf">_open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">size</span> <span class="o">=</span> <span class="mh">0x7FFFFFFF</span><span class="p">):</span>
<span class="c"># openstream helper.</span>
<span class="k">if</span> <span class="n">size</span> <span class="o"><</span> <span class="bp">self</span><span class="o">.</span><span class="n">minisectorcutoff</span><span class="p">:</span>
<span class="c"># ministream object</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ministream</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">loadminifat</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ministream</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sidlist</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">2</span><span class="p">])</span>
<span class="k">return</span> <span class="n">_OleStream</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ministream</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">minisectorsize</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">minifat</span><span class="p">)</span>
<span class="c"># standard stream</span>
<span class="k">return</span> <span class="n">_OleStream</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fp</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="mi">512</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sectorsize</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">fat</span><span class="p">)</span>
<span class="c">##</span>
<span class="c"># Returns a list of streams stored in this file.</span>
<div class="viewcode-block" id="OleFileIO.listdir"><a class="viewcode-back" href="../../PIL.html#PIL.OleFileIO.OleFileIO.listdir">[docs]</a> <span class="k">def</span> <span class="nf">listdir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return a list of streams stored in this file"""</span>
<span class="n">files</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_list</span><span class="p">(</span><span class="n">files</span><span class="p">,</span> <span class="p">[],</span> <span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">)</span>
<span class="k">return</span> <span class="n">files</span>
<span class="c">##</span>
<span class="c"># Opens a stream as a read-only file object.</span>
</div>
<div class="viewcode-block" id="OleFileIO.openstream"><a class="viewcode-back" href="../../PIL.html#PIL.OleFileIO.OleFileIO.openstream">[docs]</a> <span class="k">def</span> <span class="nf">openstream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="sd">"""Open a stream as a read-only file object"""</span>
<span class="n">slot</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
<span class="n">name</span><span class="p">,</span> <span class="nb">type</span><span class="p">,</span> <span class="n">sect</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">sids</span><span class="p">,</span> <span class="n">clsid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sidlist</span><span class="p">[</span><span class="n">slot</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">type</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"this file is not a stream"</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">(</span><span class="n">sect</span><span class="p">,</span> <span class="n">size</span><span class="p">)</span>
<span class="c">##</span>
<span class="c"># Gets a list of properties described in substream.</span>
</div>
<div class="viewcode-block" id="OleFileIO.getproperties"><a class="viewcode-back" href="../../PIL.html#PIL.OleFileIO.OleFileIO.getproperties">[docs]</a> <span class="k">def</span> <span class="nf">getproperties</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="sd">"""Return properties described in substream"""</span>
<span class="n">fp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">openstream</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">{}</span>
<span class="c"># header</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">28</span><span class="p">)</span>
<span class="n">clsid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_clsid</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="mi">8</span><span class="p">:</span><span class="mi">24</span><span class="p">])</span>
<span class="c"># format id</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">20</span><span class="p">)</span>
<span class="n">fmtid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_clsid</span><span class="p">(</span><span class="n">s</span><span class="p">[:</span><span class="mi">16</span><span class="p">])</span>
<span class="n">fp</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="mi">16</span><span class="p">))</span>
<span class="c"># get section</span>
<span class="n">s</span> <span class="o">=</span> <span class="s">"****"</span> <span class="o">+</span> <span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">i32</span><span class="p">(</span><span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">4</span><span class="p">))</span><span class="o">-</span><span class="mi">4</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="mi">4</span><span class="p">)):</span>
<span class="nb">id</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="mi">8</span><span class="o">+</span><span class="n">i</span><span class="o">*</span><span class="mi">8</span><span class="p">)</span>
<span class="n">offset</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="mi">12</span><span class="o">+</span><span class="n">i</span><span class="o">*</span><span class="mi">8</span><span class="p">)</span>
<span class="nb">type</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">offset</span><span class="p">)</span>
<span class="c"># test for common types first (should perhaps use</span>
<span class="c"># a dictionary instead?)</span>
<span class="k">if</span> <span class="nb">type</span> <span class="o">==</span> <span class="n">VT_I2</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">i16</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">)</span>
<span class="k">if</span> <span class="n">value</span> <span class="o">>=</span> <span class="mi">32768</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span> <span class="o">-</span> <span class="mi">65536</span>
<span class="k">elif</span> <span class="nb">type</span> <span class="o">==</span> <span class="n">VT_UI2</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">i16</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">type</span> <span class="ow">in</span> <span class="p">(</span><span class="n">VT_I4</span><span class="p">,</span> <span class="n">VT_ERROR</span><span class="p">):</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">type</span> <span class="o">==</span> <span class="n">VT_UI4</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">)</span> <span class="c"># FIXME</span>
<span class="k">elif</span> <span class="nb">type</span> <span class="ow">in</span> <span class="p">(</span><span class="n">VT_BSTR</span><span class="p">,</span> <span class="n">VT_LPSTR</span><span class="p">):</span>
<span class="n">count</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">)</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="o">+</span><span class="n">count</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">elif</span> <span class="nb">type</span> <span class="o">==</span> <span class="n">VT_BLOB</span><span class="p">:</span>
<span class="n">count</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">)</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="o">+</span><span class="n">count</span><span class="p">]</span>
<span class="k">elif</span> <span class="nb">type</span> <span class="o">==</span> <span class="n">VT_LPWSTR</span><span class="p">:</span>
<span class="n">count</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">)</span>
<span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_unicode</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="o">+</span><span class="n">count</span><span class="o">*</span><span class="mi">2</span><span class="p">])</span>
<span class="k">elif</span> <span class="nb">type</span> <span class="o">==</span> <span class="n">VT_FILETIME</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="nb">long</span><span class="p">(</span><span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">))</span> <span class="o">+</span> <span class="p">(</span><span class="nb">long</span><span class="p">(</span><span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="p">))</span><span class="o"><<</span><span class="mi">32</span><span class="p">)</span>
<span class="c"># FIXME: this is a 64-bit int: "number of 100ns periods</span>
<span class="c"># since Jan 1,1601". Should map this to Python time</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span> <span class="o">//</span> <span class="mi">10000000</span> <span class="c"># seconds</span>
<span class="k">elif</span> <span class="nb">type</span> <span class="o">==</span> <span class="n">VT_UI1</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">i8</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">])</span>
<span class="k">elif</span> <span class="nb">type</span> <span class="o">==</span> <span class="n">VT_CLSID</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_clsid</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">20</span><span class="p">])</span>
<span class="k">elif</span> <span class="nb">type</span> <span class="o">==</span> <span class="n">VT_CF</span><span class="p">:</span>
<span class="n">count</span> <span class="o">=</span> <span class="n">i32</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">offset</span><span class="o">+</span><span class="mi">4</span><span class="p">)</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="p">:</span><span class="n">offset</span><span class="o">+</span><span class="mi">8</span><span class="o">+</span><span class="n">count</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># everything else yields "None"</span>
<span class="c"># FIXME: add support for VT_VECTOR</span>
<span class="c">#print "%08x" % id, repr(value),</span>
<span class="c">#print "(%s)" % VT[i32(s, offset) & 0xFFF]</span>
<span class="n">data</span><span class="p">[</span><span class="nb">id</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">return</span> <span class="n">data</span>
<span class="c">#</span>
<span class="c"># --------------------------------------------------------------------</span>
<span class="c"># This script can be used to dump the directory of any OLE2 structured</span>
<span class="c"># storage file.</span>
</div></div>
<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">"__main__"</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="k">for</span> <span class="nb">file</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:]:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">ole</span> <span class="o">=</span> <span class="n">OleFileIO</span><span class="p">(</span><span class="nb">file</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="s">"-"</span> <span class="o">*</span> <span class="mi">68</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="nb">file</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="s">"-"</span> <span class="o">*</span> <span class="mi">68</span><span class="p">)</span>
<span class="n">ole</span><span class="o">.</span><span class="n">dumpdirectory</span><span class="p">()</span>
<span class="k">for</span> <span class="nb">file</span> <span class="ow">in</span> <span class="n">ole</span><span class="o">.</span><span class="n">listdir</span><span class="p">():</span>
<span class="k">if</span> <span class="nb">file</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">"</span><span class="se">\005</span><span class="s">"</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="nb">file</span><span class="p">)</span>
<span class="n">props</span> <span class="o">=</span> <span class="n">ole</span><span class="o">.</span><span class="n">getproperties</span><span class="p">(</span><span class="nb">file</span><span class="p">)</span>
<span class="n">props</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">props</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">props</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="s">" "</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">v</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="s">"***"</span><span class="p">,</span> <span class="s">"cannot read"</span><span class="p">,</span> <span class="nb">file</span><span class="p">,</span> <span class="s">"-"</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">Pillow (PIL fork) 2.2.0 documentation</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 1997-2011 by Secret Labs AB, 1995-2011 by Fredrik Lundh, 2010-2013 Alex Clark.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
