1407 lines
145 KiB
HTML
1407 lines
145 KiB
HTML
<!doctype html>
|
|
<html class="no-js">
|
|
<head><meta charset="utf-8"/>
|
|
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
|
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" />
|
|
|
|
<meta name="generator" content="sphinx-4.4.0, furo 2022.04.07"/>
|
|
<title>osxphotos.export_db - osxphotos 0.49.7 documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
|
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
|
|
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
|
|
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
|
|
|
|
|
|
|
|
|
<style>
|
|
body {
|
|
--color-code-background: #f8f8f8;
|
|
--color-code-foreground: black;
|
|
|
|
}
|
|
@media not print {
|
|
body[data-theme="dark"] {
|
|
--color-code-background: #202020;
|
|
--color-code-foreground: #d0d0d0;
|
|
|
|
}
|
|
@media (prefers-color-scheme: dark) {
|
|
body:not([data-theme="light"]) {
|
|
--color-code-background: #202020;
|
|
--color-code-foreground: #d0d0d0;
|
|
|
|
}
|
|
}
|
|
}
|
|
</style></head>
|
|
<body>
|
|
|
|
<script>
|
|
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
|
</script>
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
|
<symbol id="svg-toc" viewBox="0 0 24 24">
|
|
<title>Contents</title>
|
|
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
|
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-menu" viewBox="0 0 24 24">
|
|
<title>Menu</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
|
<line x1="3" y1="12" x2="21" y2="12"></line>
|
|
<line x1="3" y1="6" x2="21" y2="6"></line>
|
|
<line x1="3" y1="18" x2="21" y2="18"></line>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
|
<title>Expand</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
|
<polyline points="9 18 15 12 9 6"></polyline>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-sun" viewBox="0 0 24 24">
|
|
<title>Light mode</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
|
<circle cx="12" cy="12" r="5"></circle>
|
|
<line x1="12" y1="1" x2="12" y2="3"></line>
|
|
<line x1="12" y1="21" x2="12" y2="23"></line>
|
|
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
|
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
|
<line x1="1" y1="12" x2="3" y2="12"></line>
|
|
<line x1="21" y1="12" x2="23" y2="12"></line>
|
|
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
|
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-moon" viewBox="0 0 24 24">
|
|
<title>Dark mode</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
|
<title>Auto light/dark mode</title>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
|
<circle cx="12" cy="12" r="9" />
|
|
<path d="M13 12h5" />
|
|
<path d="M13 15h4" />
|
|
<path d="M13 18h1" />
|
|
<path d="M13 9h4" />
|
|
<path d="M13 6h1" />
|
|
</svg>
|
|
</symbol>
|
|
</svg>
|
|
|
|
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
|
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
|
<label class="overlay sidebar-overlay" for="__navigation">
|
|
<div class="visually-hidden">Hide navigation sidebar</div>
|
|
</label>
|
|
<label class="overlay toc-overlay" for="__toc">
|
|
<div class="visually-hidden">Hide table of contents sidebar</div>
|
|
</label>
|
|
|
|
|
|
|
|
<div class="page">
|
|
<header class="mobile-header">
|
|
<div class="header-left">
|
|
<label class="nav-overlay-icon" for="__navigation">
|
|
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
|
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
|
</label>
|
|
</div>
|
|
<div class="header-center">
|
|
<a href="../../index.html"><div class="brand">osxphotos 0.49.7 documentation</div></a>
|
|
</div>
|
|
<div class="header-right">
|
|
<div class="theme-toggle-container theme-toggle-header">
|
|
<button class="theme-toggle">
|
|
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
</button>
|
|
</div>
|
|
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
|
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
</label>
|
|
</div>
|
|
</header>
|
|
<aside class="sidebar-drawer">
|
|
<div class="sidebar-container">
|
|
|
|
<div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
|
|
|
|
|
|
<span class="sidebar-brand-text">osxphotos 0.49.7 documentation</span>
|
|
|
|
</a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
|
|
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
|
<input type="hidden" name="check_keywords" value="yes">
|
|
<input type="hidden" name="area" value="default">
|
|
</form>
|
|
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../overview.html">OSXPhotos</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html">OSXPhotos Tutorial</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../cli.html">OSXPhotos Command Line Interface (CLI)</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../template_help.html">OSXPhotos Template System</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../package_overview.html">OSXPhotos Python Package Overview</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../reference.html">OSXPhotos python API</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</aside>
|
|
<div class="main">
|
|
<div class="content">
|
|
<div class="article-container">
|
|
<a href="#" class="back-to-top muted-link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
|
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
|
</svg>
|
|
<span>Back to top</span>
|
|
</a>
|
|
<div class="content-icon-container"><div class="theme-toggle-container theme-toggle-content">
|
|
<button class="theme-toggle">
|
|
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
</button>
|
|
</div>
|
|
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
|
|
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
</label>
|
|
</div>
|
|
<article role="main">
|
|
<h1>Source code for osxphotos.export_db</h1><div class="highlight"><pre>
|
|
<span></span><span class="sd">""" Helper class for managing database used by PhotoExporter for tracking state of exports and updates """</span>
|
|
|
|
|
|
<span class="kn">import</span> <span class="nn">datetime</span>
|
|
<span class="kn">import</span> <span class="nn">gzip</span>
|
|
<span class="kn">import</span> <span class="nn">json</span>
|
|
<span class="kn">import</span> <span class="nn">logging</span>
|
|
<span class="kn">import</span> <span class="nn">os</span>
|
|
<span class="kn">import</span> <span class="nn">os.path</span>
|
|
<span class="kn">import</span> <span class="nn">pathlib</span>
|
|
<span class="kn">import</span> <span class="nn">pickle</span>
|
|
<span class="kn">import</span> <span class="nn">re</span>
|
|
<span class="kn">import</span> <span class="nn">sqlite3</span>
|
|
<span class="kn">import</span> <span class="nn">sys</span>
|
|
<span class="kn">import</span> <span class="nn">time</span>
|
|
<span class="kn">from</span> <span class="nn">contextlib</span> <span class="kn">import</span> <span class="n">suppress</span>
|
|
<span class="kn">from</span> <span class="nn">io</span> <span class="kn">import</span> <span class="n">StringIO</span>
|
|
<span class="kn">from</span> <span class="nn">sqlite3</span> <span class="kn">import</span> <span class="n">Error</span>
|
|
<span class="kn">from</span> <span class="nn">tempfile</span> <span class="kn">import</span> <span class="n">TemporaryDirectory</span>
|
|
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Union</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">tenacity</span> <span class="kn">import</span> <span class="n">retry</span><span class="p">,</span> <span class="n">stop_after_attempt</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">._constants</span> <span class="kn">import</span> <span class="n">OSXPHOTOS_EXPORT_DB</span>
|
|
<span class="kn">from</span> <span class="nn">._version</span> <span class="kn">import</span> <span class="n">__version__</span>
|
|
<span class="kn">from</span> <span class="nn">.fileutil</span> <span class="kn">import</span> <span class="n">FileUtil</span>
|
|
<span class="kn">from</span> <span class="nn">.utils</span> <span class="kn">import</span> <span class="n">normalize_fs_path</span>
|
|
|
|
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="s2">"ExportDB"</span><span class="p">,</span>
|
|
<span class="s2">"ExportDBInMemory"</span><span class="p">,</span>
|
|
<span class="s2">"ExportDBTemp"</span><span class="p">,</span>
|
|
<span class="p">]</span>
|
|
|
|
<span class="n">OSXPHOTOS_EXPORTDB_VERSION</span> <span class="o">=</span> <span class="s2">"7.1"</span>
|
|
<span class="n">OSXPHOTOS_ABOUT_STRING</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Created by osxphotos version </span><span class="si">{</span><span class="n">__version__</span><span class="si">}</span><span class="s2"> (https://github.com/RhetTbull/osxphotos) on </span><span class="si">{</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="si">}</span><span class="s2">"</span>
|
|
|
|
<span class="c1"># max retry attempts for methods which use tenacity.retry</span>
|
|
<span class="n">MAX_RETRY_ATTEMPTS</span> <span class="o">=</span> <span class="mi">5</span>
|
|
|
|
<span class="c1"># maximum number of export results rows to save</span>
|
|
<span class="n">MAX_EXPORT_RESULTS_DATA_ROWS</span> <span class="o">=</span> <span class="mi">10</span>
|
|
|
|
|
|
<span class="k">def</span> <span class="nf">pickle_and_zip</span><span class="p">(</span><span class="n">data</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bytes</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Pickle and gzip data.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> data: data to pickle and gzip (must be pickle-able)</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> bytes of gzipped pickled data</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">pickled</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">gzip</span><span class="o">.</span><span class="n">compress</span><span class="p">(</span><span class="n">pickled</span><span class="p">)</span>
|
|
|
|
|
|
<span class="k">def</span> <span class="nf">unzip_and_unpickle</span><span class="p">(</span><span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-></span> <span class="n">Any</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Unzip and unpickle data.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> data: data to unzip and unpickle</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> unpickled data</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="n">pickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">gzip</span><span class="o">.</span><span class="n">decompress</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
|
|
|
|
|
|
<div class="viewcode-block" id="ExportDB"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB">[docs]</a><span class="k">class</span> <span class="nc">ExportDB</span><span class="p">:</span>
|
|
<span class="sd">"""Interface to sqlite3 database used to store state information for osxphotos export command"""</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dbfile</span><span class="p">,</span> <span class="n">export_dir</span><span class="p">):</span>
|
|
<span class="sd">"""create a new ExportDB object</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> dbfile: path to osxphotos export database file</span>
|
|
<span class="sd"> export_dir: path to directory where exported files are stored</span>
|
|
<span class="sd"> memory: if True, use in-memory database</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_dbfile</span> <span class="o">=</span> <span class="n">dbfile</span>
|
|
<span class="c1"># export_dir is required as all files referenced by get_/set_uuid_for_file will be converted to</span>
|
|
<span class="c1"># relative paths to this path</span>
|
|
<span class="c1"># this allows the entire export tree to be moved to a new disk/location</span>
|
|
<span class="c1"># whilst preserving the UUID to filename mapping</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">export_dir</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_open_export_db</span><span class="p">(</span><span class="n">dbfile</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_perform_db_maintenace</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_conn</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_insert_run_info</span><span class="p">()</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""returns path to export database"""</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dbfile</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">export_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""returns path to export directory"""</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span>
|
|
|
|
<div class="viewcode-block" id="ExportDB.get_file_record"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.get_file_record">[docs]</a> <span class="k">def</span> <span class="nf">get_file_record</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="n">Union</span><span class="p">[</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="nb">str</span><span class="p">])</span> <span class="o">-></span> <span class="s2">"ExportRecord"</span><span class="p">:</span>
|
|
<span class="sd">"""get info for filename and uuid</span>
|
|
|
|
<span class="sd"> Returns: an ExportRecord object or None if filename not found</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">filename</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_relative_filepath</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
|
|
<span class="n">filename_normalized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_normalize_filepath</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
|
|
<span class="k">if</span> <span class="n">_</span> <span class="o">:=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT uuid FROM export_data WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">filename_normalized</span><span class="p">,),</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="n">ExportRecord</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">filename_normalized</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="kc">None</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.create_file_record"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.create_file_record">[docs]</a> <span class="k">def</span> <span class="nf">create_file_record</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="n">Union</span><span class="p">[</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span> <span class="n">uuid</span><span class="p">:</span> <span class="nb">str</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="s2">"ExportRecord"</span><span class="p">:</span>
|
|
<span class="sd">"""create a new record for filename and uuid</span>
|
|
|
|
<span class="sd"> Returns: an ExportRecord object</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">filename</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_relative_filepath</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
|
|
<span class="n">filename_normalized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_normalize_filepath</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"INSERT INTO export_data (filepath, filepath_normalized, uuid) VALUES (?, ?, ?);"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">filename_normalized</span><span class="p">,</span> <span class="n">uuid</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="n">ExportRecord</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">filename_normalized</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.create_or_get_file_record"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.create_or_get_file_record">[docs]</a> <span class="k">def</span> <span class="nf">create_or_get_file_record</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="n">Union</span><span class="p">[</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span> <span class="n">uuid</span><span class="p">:</span> <span class="nb">str</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="s2">"ExportRecord"</span><span class="p">:</span>
|
|
<span class="sd">"""create a new record for filename and uuid or return existing record</span>
|
|
|
|
<span class="sd"> Returns: an ExportRecord object</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">filename</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_relative_filepath</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
|
|
<span class="n">filename_normalized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_normalize_filepath</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"INSERT OR IGNORE INTO export_data (filepath, filepath_normalized, uuid) VALUES (?, ?, ?);"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">filename_normalized</span><span class="p">,</span> <span class="n">uuid</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="n">ExportRecord</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">filename_normalized</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.get_uuid_for_file"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.get_uuid_for_file">[docs]</a> <span class="k">def</span> <span class="nf">get_uuid_for_file</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">"""query database for filename and return UUID</span>
|
|
<span class="sd"> returns None if filename not found in database</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">filepath_normalized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_normalize_filepath_relative</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT uuid FROM export_data WHERE filepath_normalized = ?"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">filepath_normalized</span><span class="p">,),</span>
|
|
<span class="p">)</span>
|
|
<span class="n">results</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
|
|
<span class="n">uuid</span> <span class="o">=</span> <span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">results</span> <span class="k">else</span> <span class="kc">None</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
<span class="n">uuid</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="k">return</span> <span class="n">uuid</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.get_files_for_uuid"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.get_files_for_uuid">[docs]</a> <span class="k">def</span> <span class="nf">get_files_for_uuid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">:</span>
|
|
<span class="sd">"""query database for UUID and return list of files associated with UUID or empty list"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT filepath FROM export_data WHERE uuid = ?"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">uuid</span><span class="p">,),</span>
|
|
<span class="p">)</span>
|
|
<span class="n">results</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">export_dir</span><span class="p">,</span> <span class="n">r</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">results</span><span class="p">]</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.get_photoinfo_for_uuid"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.get_photoinfo_for_uuid">[docs]</a> <span class="k">def</span> <span class="nf">get_photoinfo_for_uuid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
|
|
<span class="sd">"""returns the photoinfo JSON struct for a UUID"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"SELECT photoinfo FROM photoinfo WHERE uuid = ?"</span><span class="p">,</span> <span class="p">(</span><span class="n">uuid</span><span class="p">,))</span>
|
|
<span class="n">results</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
|
|
<span class="n">info</span> <span class="o">=</span> <span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">results</span> <span class="k">else</span> <span class="kc">None</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
<span class="n">info</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="k">return</span> <span class="n">info</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.set_photoinfo_for_uuid"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.set_photoinfo_for_uuid">[docs]</a> <span class="k">def</span> <span class="nf">set_photoinfo_for_uuid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">info</span><span class="p">):</span>
|
|
<span class="sd">"""sets the photoinfo JSON struct for a UUID"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"INSERT OR REPLACE INTO photoinfo(uuid, photoinfo) VALUES (?, ?);"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="n">info</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.get_target_for_file"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.get_target_for_file">[docs]</a> <span class="k">def</span> <span class="nf">get_target_for_file</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">filename</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">]</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
|
|
<span class="sd">"""query database for file matching file name and return the matching filename if there is one;</span>
|
|
<span class="sd"> otherwise return None; looks for file.ext, file (1).ext, file (2).ext and so on to find the</span>
|
|
<span class="sd"> actual target name that was used to export filename</span>
|
|
|
|
<span class="sd"> Returns: the matching filename or None if no match found</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">filepath_normalized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_normalize_filepath_relative</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
|
|
<span class="n">filepath_stem</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">filepath_normalized</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT uuid, filepath, filepath_normalized FROM export_data WHERE uuid = ? AND filepath_normalized LIKE ?"</span><span class="p">,</span>
|
|
<span class="p">(</span>
|
|
<span class="n">uuid</span><span class="p">,</span>
|
|
<span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">filepath_stem</span><span class="si">}</span><span class="s2">%"</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="n">results</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
|
|
|
|
<span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">results</span><span class="p">:</span>
|
|
<span class="n">filepath_normalized</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="mi">2</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span>
|
|
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">filepath_stem</span><span class="p">)</span> <span class="o">+</span> <span class="sa">r</span><span class="s2">"(\s\(\d+\))?$"</span><span class="p">,</span> <span class="n">filepath_normalized</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">export_dir</span><span class="p">,</span> <span class="n">result</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
|
|
|
|
<span class="k">return</span> <span class="kc">None</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.get_previous_uuids"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.get_previous_uuids">[docs]</a> <span class="k">def</span> <span class="nf">get_previous_uuids</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""returns list of UUIDs of previously exported photos found in export database"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">previous_uuids</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"SELECT DISTINCT uuid FROM export_data"</span><span class="p">)</span>
|
|
<span class="n">results</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
|
|
<span class="n">previous_uuids</span> <span class="o">=</span> <span class="p">[</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">results</span><span class="p">]</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">previous_uuids</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.set_config"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.set_config">[docs]</a> <span class="k">def</span> <span class="nf">set_config</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config_data</span><span class="p">):</span>
|
|
<span class="sd">"""set config in the database"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">isoformat</span><span class="p">()</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"INSERT OR REPLACE INTO config(datetime, config) VALUES (?, ?);"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">config_data</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.set_export_results"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.set_export_results">[docs]</a> <span class="k">def</span> <span class="nf">set_export_results</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">results</span><span class="p">):</span>
|
|
<span class="sd">"""Store export results in database; data is pickled and gzipped for storage"""</span>
|
|
|
|
<span class="n">results_data</span> <span class="o">=</span> <span class="n">pickle_and_zip</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
|
|
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">isoformat</span><span class="p">()</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> UPDATE export_results_data</span>
|
|
<span class="sd"> SET datetime = ?,</span>
|
|
<span class="sd"> export_results = ?</span>
|
|
<span class="sd"> WHERE datetime = (SELECT MIN(datetime) FROM export_results_data);</span>
|
|
<span class="sd"> """</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">results_data</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.get_export_results"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.get_export_results">[docs]</a> <span class="k">def</span> <span class="nf">get_export_results</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">run</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
|
|
<span class="sd">"""Retrieve export results from database</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> run: which run to retrieve results for;</span>
|
|
<span class="sd"> 0 = most recent run, -1 = previous run, -2 = run prior to that, etc.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> ExportResults object or None if no results found</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="n">run</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"run must be 0 or negative"</span><span class="p">)</span>
|
|
<span class="n">run</span> <span class="o">=</span> <span class="o">-</span><span class="n">run</span>
|
|
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> SELECT export_results</span>
|
|
<span class="sd"> FROM export_results_data</span>
|
|
<span class="sd"> ORDER BY datetime DESC</span>
|
|
<span class="sd"> """</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">rows</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">data</span> <span class="o">=</span> <span class="n">rows</span><span class="p">[</span><span class="n">run</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
|
|
<span class="n">results</span> <span class="o">=</span> <span class="n">unzip_and_unpickle</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="k">if</span> <span class="n">data</span> <span class="k">else</span> <span class="kc">None</span>
|
|
<span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
|
|
<span class="n">results</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
<span class="n">results</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="k">return</span> <span class="n">results</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.get_exported_files"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.get_exported_files">[docs]</a> <span class="k">def</span> <span class="nf">get_exported_files</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Returns tuple of (uuid, filepath) for all paths of all exported files tracked in the database"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"SELECT uuid, filepath FROM export_data"</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="k">while</span> <span class="n">row</span> <span class="o">:=</span> <span class="n">c</span><span class="o">.</span><span class="n">fetchone</span><span class="p">():</span>
|
|
<span class="k">yield</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">export_dir</span><span class="p">,</span> <span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
|
|
<span class="k">return</span></div>
|
|
|
|
<div class="viewcode-block" id="ExportDB.close"><a class="viewcode-back" href="../../reference.html#osxphotos.ExportDB.close">[docs]</a> <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""close the database connection"""</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span></div>
|
|
|
|
<span class="k">def</span> <span class="nf">_open_export_db</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dbfile</span><span class="p">):</span>
|
|
<span class="sd">"""open export database and return a db connection</span>
|
|
<span class="sd"> if dbfile does not exist, will create and initialize the database</span>
|
|
<span class="sd"> if dbfile needs to be upgraded, will perform needed migrations</span>
|
|
<span class="sd"> returns: connection to the database</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">dbfile</span><span class="p">):</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_db_connection</span><span class="p">(</span><span class="n">dbfile</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">conn</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Error getting connection to database </span><span class="si">{</span><span class="n">dbfile</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_create_or_migrate_db_tables</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">was_created</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">was_upgraded</span> <span class="o">=</span> <span class="p">()</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_db_connection</span><span class="p">(</span><span class="n">dbfile</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">was_created</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="n">version_info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_database_version</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">version_info</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o"><</span> <span class="n">OSXPHOTOS_EXPORTDB_VERSION</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_create_or_migrate_db_tables</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">was_upgraded</span> <span class="o">=</span> <span class="p">(</span><span class="n">version_info</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">OSXPHOTOS_EXPORTDB_VERSION</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">was_upgraded</span> <span class="o">=</span> <span class="p">()</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">=</span> <span class="n">OSXPHOTOS_EXPORTDB_VERSION</span>
|
|
|
|
<span class="c1"># turn on performance optimizations</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"PRAGMA journal_mode=WAL;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"PRAGMA synchronous=NORMAL;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"PRAGMA cache_size=-100000;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"PRAGMA temp_store=MEMORY;"</span><span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="n">conn</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_get_db_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dbfile</span><span class="p">):</span>
|
|
<span class="sd">"""return db connection to dbname"""</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">dbfile</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="k">return</span> <span class="n">conn</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_get_database_version</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
|
|
<span class="sd">"""return tuple of (osxphotos, exportdb) versions for database connection conn"""</span>
|
|
<span class="n">version_info</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT osxphotos, exportdb, max(id) FROM version"</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="p">(</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">version_info</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_create_or_migrate_db_tables</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
|
|
<span class="sd">"""create (if not already created) the necessary db tables for the export database and apply any needed migrations</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> conn: sqlite3 db connection</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">version</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_database_version</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">version</span> <span class="o">=</span> <span class="p">(</span><span class="n">__version__</span><span class="p">,</span> <span class="s2">"4.3"</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Current for version 4.3, for anything greater, do a migration after creation</span>
|
|
<span class="n">sql_commands</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS version (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> osxphotos TEXT,</span>
|
|
<span class="sd"> exportdb TEXT </span>
|
|
<span class="sd"> ); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS about (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> about TEXT</span>
|
|
<span class="sd"> );"""</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS files (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> filepath TEXT NOT NULL,</span>
|
|
<span class="sd"> filepath_normalized TEXT NOT NULL,</span>
|
|
<span class="sd"> uuid TEXT,</span>
|
|
<span class="sd"> orig_mode INTEGER,</span>
|
|
<span class="sd"> orig_size INTEGER,</span>
|
|
<span class="sd"> orig_mtime REAL,</span>
|
|
<span class="sd"> exif_mode INTEGER,</span>
|
|
<span class="sd"> exif_size INTEGER,</span>
|
|
<span class="sd"> exif_mtime REAL</span>
|
|
<span class="sd"> ); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS runs (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> datetime TEXT,</span>
|
|
<span class="sd"> python_path TEXT,</span>
|
|
<span class="sd"> script_name TEXT,</span>
|
|
<span class="sd"> args TEXT,</span>
|
|
<span class="sd"> cwd TEXT </span>
|
|
<span class="sd"> ); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS info (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> uuid text NOT NULL,</span>
|
|
<span class="sd"> json_info JSON </span>
|
|
<span class="sd"> ); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS exifdata (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> filepath_normalized TEXT NOT NULL,</span>
|
|
<span class="sd"> json_exifdata JSON </span>
|
|
<span class="sd"> ); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS edited (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> filepath_normalized TEXT NOT NULL,</span>
|
|
<span class="sd"> mode INTEGER,</span>
|
|
<span class="sd"> size INTEGER,</span>
|
|
<span class="sd"> mtime REAL</span>
|
|
<span class="sd"> ); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS converted (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> filepath_normalized TEXT NOT NULL,</span>
|
|
<span class="sd"> mode INTEGER,</span>
|
|
<span class="sd"> size INTEGER,</span>
|
|
<span class="sd"> mtime REAL</span>
|
|
<span class="sd"> ); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS sidecar (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> filepath_normalized TEXT NOT NULL,</span>
|
|
<span class="sd"> sidecar_data TEXT,</span>
|
|
<span class="sd"> mode INTEGER,</span>
|
|
<span class="sd"> size INTEGER,</span>
|
|
<span class="sd"> mtime REAL</span>
|
|
<span class="sd"> ); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS detected_text (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> uuid TEXT NOT NULL,</span>
|
|
<span class="sd"> text_data JSON</span>
|
|
<span class="sd"> ); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE UNIQUE INDEX IF NOT EXISTS idx_files_filepath_normalized on files (filepath_normalized); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE UNIQUE INDEX IF NOT EXISTS idx_info_uuid on info (uuid); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE UNIQUE INDEX IF NOT EXISTS idx_exifdata_filename on exifdata (filepath_normalized); """</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE UNIQUE INDEX IF NOT EXISTS idx_edited_filename on edited (filepath_normalized);"""</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE UNIQUE INDEX IF NOT EXISTS idx_converted_filename on converted (filepath_normalized);"""</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE UNIQUE INDEX IF NOT EXISTS idx_sidecar_filename on sidecar (filepath_normalized);"""</span><span class="p">,</span>
|
|
<span class="sd">""" CREATE UNIQUE INDEX IF NOT EXISTS idx_detected_text on detected_text (uuid);"""</span><span class="p">,</span>
|
|
<span class="p">]</span>
|
|
<span class="c1"># create the tables if needed</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="k">for</span> <span class="n">cmd</span> <span class="ow">in</span> <span class="n">sql_commands</span><span class="p">:</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"INSERT INTO version(osxphotos, exportdb) VALUES (?, ?);"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">__version__</span><span class="p">,</span> <span class="n">OSXPHOTOS_EXPORTDB_VERSION</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"INSERT INTO about(about) VALUES (?);"</span><span class="p">,</span> <span class="p">(</span><span class="n">OSXPHOTOS_ABOUT_STRING</span><span class="p">,))</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
|
|
<span class="c1"># perform needed migrations</span>
|
|
<span class="k">if</span> <span class="n">version</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o"><</span> <span class="s2">"4.3"</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_migrate_normalized_filepath</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="n">version</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o"><</span> <span class="s2">"5.0"</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_migrate_4_3_to_5_0</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="n">version</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o"><</span> <span class="s2">"6.0"</span><span class="p">:</span>
|
|
<span class="c1"># create export_data table</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_migrate_5_0_to_6_0</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="n">version</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o"><</span> <span class="s2">"7.0"</span><span class="p">:</span>
|
|
<span class="c1"># create report_data table</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_migrate_6_0_to_7_0</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="n">version</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o"><</span> <span class="s2">"7.1"</span><span class="p">:</span>
|
|
<span class="c1"># add timestamp to export_data</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_migrate_7_0_to_7_1</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"VACUUM;"</span><span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""ensure the database connection is closed"""</span>
|
|
<span class="k">with</span> <span class="n">suppress</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_insert_run_info</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">timezone</span><span class="o">.</span><span class="n">utc</span><span class="p">)</span><span class="o">.</span><span class="n">isoformat</span><span class="p">()</span>
|
|
<span class="n">python_path</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">executable</span>
|
|
<span class="n">cmd</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
|
<span class="n">args</span> <span class="o">=</span> <span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</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">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span> <span class="k">else</span> <span class="s2">""</span>
|
|
<span class="n">cwd</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"INSERT INTO runs (datetime, python_path, script_name, args, cwd) VALUES (?, ?, ?, ?, ?)"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">python_path</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">cwd</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_relative_filepath</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filepath</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">])</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<span class="sd">"""return filepath relative to self._path"""</span>
|
|
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="n">filepath</span><span class="p">)</span><span class="o">.</span><span class="n">relative_to</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_path</span><span class="p">))</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_normalize_filepath</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filepath</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">])</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<span class="sd">"""normalize filepath for unicode, lower case"""</span>
|
|
<span class="k">return</span> <span class="n">normalize_fs_path</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">filepath</span><span class="p">))</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_normalize_filepath_relative</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filepath</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">])</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<span class="sd">"""normalize filepath for unicode, relative path (to export dir), lower case"""</span>
|
|
<span class="n">filepath</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_relative_filepath</span><span class="p">(</span><span class="n">filepath</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">normalize_fs_path</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">filepath</span><span class="p">))</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_migrate_normalized_filepath</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
|
|
<span class="sd">"""Fix all filepath_normalized columns for unicode normalization"""</span>
|
|
<span class="c1"># Prior to database version 4.3, filepath_normalized was not normalized for unicode</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">migration_sql</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS files_migrate (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> filepath TEXT NOT NULL,</span>
|
|
<span class="sd"> filepath_normalized TEXT NOT NULL,</span>
|
|
<span class="sd"> uuid TEXT,</span>
|
|
<span class="sd"> orig_mode INTEGER,</span>
|
|
<span class="sd"> orig_size INTEGER,</span>
|
|
<span class="sd"> orig_mtime REAL,</span>
|
|
<span class="sd"> exif_mode INTEGER,</span>
|
|
<span class="sd"> exif_size INTEGER,</span>
|
|
<span class="sd"> exif_mtime REAL,</span>
|
|
<span class="sd"> UNIQUE(filepath_normalized)</span>
|
|
<span class="sd"> ); """</span><span class="p">,</span>
|
|
<span class="sd">""" INSERT INTO files_migrate SELECT * FROM files;"""</span><span class="p">,</span>
|
|
<span class="sd">""" DROP TABLE files;"""</span><span class="p">,</span>
|
|
<span class="sd">""" ALTER TABLE files_migrate RENAME TO files;"""</span><span class="p">,</span>
|
|
<span class="p">]</span>
|
|
<span class="k">for</span> <span class="n">sql</span> <span class="ow">in</span> <span class="n">migration_sql</span><span class="p">:</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
|
|
<span class="k">for</span> <span class="n">table</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"converted"</span><span class="p">,</span> <span class="s2">"edited"</span><span class="p">,</span> <span class="s2">"exifdata"</span><span class="p">,</span> <span class="s2">"files"</span><span class="p">,</span> <span class="s2">"sidecar"</span><span class="p">]:</span>
|
|
<span class="n">old_values</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"SELECT filepath_normalized, id FROM </span><span class="si">{</span><span class="n">table</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
|
|
<span class="n">new_values</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_normalize_filepath</span><span class="p">(</span><span class="n">filepath_normalized</span><span class="p">),</span> <span class="n">id_</span><span class="p">)</span>
|
|
<span class="k">for</span> <span class="n">filepath_normalized</span><span class="p">,</span> <span class="n">id_</span> <span class="ow">in</span> <span class="n">old_values</span>
|
|
<span class="p">]</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">executemany</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"UPDATE </span><span class="si">{</span><span class="n">table</span><span class="si">}</span><span class="s2"> SET filepath_normalized=? WHERE id=?"</span><span class="p">,</span> <span class="n">new_values</span>
|
|
<span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_migrate_4_3_to_5_0</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
|
|
<span class="sd">"""Migrate database from version 4.3 to 5.0"""</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="c1"># add metadata column to files to support --force-update</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"ALTER TABLE files ADD COLUMN metadata TEXT;"</span><span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_migrate_5_0_to_6_0</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
|
|
<span class="c1"># add export_data table</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS export_data(</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> filepath_normalized TEXT NOT NULL,</span>
|
|
<span class="sd"> filepath TEXT NOT NULL,</span>
|
|
<span class="sd"> uuid TEXT NOT NULL,</span>
|
|
<span class="sd"> src_mode INTEGER,</span>
|
|
<span class="sd"> src_size INTEGER,</span>
|
|
<span class="sd"> src_mtime REAL,</span>
|
|
<span class="sd"> dest_mode INTEGER,</span>
|
|
<span class="sd"> dest_size INTEGER,</span>
|
|
<span class="sd"> dest_mtime REAL,</span>
|
|
<span class="sd"> digest TEXT,</span>
|
|
<span class="sd"> exifdata JSON,</span>
|
|
<span class="sd"> export_options INTEGER,</span>
|
|
<span class="sd"> UNIQUE(filepath_normalized)</span>
|
|
<span class="sd"> ); """</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">""" CREATE UNIQUE INDEX IF NOT EXISTS idx_export_data_filepath_normalized on export_data (filepath_normalized); """</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="c1"># migrate data</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">""" INSERT INTO export_data (filepath_normalized, filepath, uuid) SELECT filepath_normalized, filepath, uuid FROM files;"""</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">""" UPDATE export_data </span>
|
|
<span class="sd"> SET (src_mode, src_size, src_mtime) = </span>
|
|
<span class="sd"> (SELECT mode, size, mtime </span>
|
|
<span class="sd"> FROM edited </span>
|
|
<span class="sd"> WHERE export_data.filepath_normalized = edited.filepath_normalized);</span>
|
|
<span class="sd"> """</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">""" UPDATE export_data </span>
|
|
<span class="sd"> SET (dest_mode, dest_size, dest_mtime) = </span>
|
|
<span class="sd"> (SELECT orig_mode, orig_size, orig_mtime </span>
|
|
<span class="sd"> FROM files </span>
|
|
<span class="sd"> WHERE export_data.filepath_normalized = files.filepath_normalized);</span>
|
|
<span class="sd"> """</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">""" UPDATE export_data SET digest = </span>
|
|
<span class="sd"> (SELECT metadata FROM files </span>
|
|
<span class="sd"> WHERE files.filepath_normalized = export_data.filepath_normalized</span>
|
|
<span class="sd"> ); """</span>
|
|
<span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">""" UPDATE export_data SET exifdata = </span>
|
|
<span class="sd"> (SELECT json_exifdata FROM exifdata </span>
|
|
<span class="sd"> WHERE exifdata.filepath_normalized = export_data.filepath_normalized</span>
|
|
<span class="sd"> ); """</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="c1"># create config table</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS config (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> datetime TEXT,</span>
|
|
<span class="sd"> config TEXT </span>
|
|
<span class="sd"> ); """</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="c1"># create photoinfo table</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">""" CREATE TABLE IF NOT EXISTS photoinfo (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> uuid TEXT NOT NULL,</span>
|
|
<span class="sd"> photoinfo JSON,</span>
|
|
<span class="sd"> UNIQUE(uuid)</span>
|
|
<span class="sd"> ); """</span>
|
|
<span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">"""CREATE UNIQUE INDEX IF NOT EXISTS idx_photoinfo_uuid on photoinfo (uuid);"""</span>
|
|
<span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">""" INSERT INTO photoinfo (uuid, photoinfo) SELECT uuid, json_info FROM info;"""</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="c1"># drop indexes no longer needed</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP INDEX IF EXISTS idx_files_filepath_normalized;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP INDEX IF EXISTS idx_exifdata_filename;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP INDEX IF EXISTS idx_edited_filename;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP INDEX IF EXISTS idx_converted_filename;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP INDEX IF EXISTS idx_sidecar_filename;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP INDEX IF EXISTS idx_detected_text;"</span><span class="p">)</span>
|
|
|
|
<span class="c1"># drop tables no longer needed</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP TABLE IF EXISTS files;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP TABLE IF EXISTS info;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP TABLE IF EXISTS exifdata;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP TABLE IF EXISTS edited;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP TABLE IF EXISTS converted;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP TABLE IF EXISTS sidecar;"</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"DROP TABLE IF EXISTS detected_text;"</span><span class="p">)</span>
|
|
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_migrate_6_0_to_7_0</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">"""CREATE TABLE IF NOT EXISTS export_results_data (</span>
|
|
<span class="sd"> id INTEGER PRIMARY KEY,</span>
|
|
<span class="sd"> datetime TEXT,</span>
|
|
<span class="sd"> export_results BLOB</span>
|
|
<span class="sd"> );"""</span>
|
|
<span class="p">)</span>
|
|
<span class="c1"># pre-populate report_data table with blank fields</span>
|
|
<span class="c1"># ExportDB will use these as circular buffer always writing to the oldest record</span>
|
|
<span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">MAX_EXPORT_RESULTS_DATA_ROWS</span><span class="p">):</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">"""INSERT INTO export_results_data (datetime, export_results) VALUES (?, ?);"""</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">isoformat</span><span class="p">(),</span> <span class="sa">b</span><span class="s2">""</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="c1"># sleep a tiny bit just to ensure time stamps increment</span>
|
|
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">0.001</span><span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_migrate_7_0_to_7_1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"""ALTER TABLE export_data ADD COLUMN timestamp DATETIME;"""</span><span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> CREATE TRIGGER insert_timestamp_trigger</span>
|
|
<span class="sd"> AFTER INSERT ON export_data</span>
|
|
<span class="sd"> BEGIN</span>
|
|
<span class="sd"> UPDATE export_data SET timestamp = STRFTIME('%Y-%m-%d %H:%M:%f', 'NOW') WHERE id = NEW.id;</span>
|
|
<span class="sd"> END;</span>
|
|
<span class="sd"> """</span>
|
|
<span class="p">)</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> CREATE TRIGGER update_timestamp_trigger</span>
|
|
<span class="sd"> AFTER UPDATE On export_data</span>
|
|
<span class="sd"> BEGIN</span>
|
|
<span class="sd"> UPDATE export_data SET timestamp = STRFTIME('%Y-%m-%d %H:%M:%f', 'NOW') WHERE id = NEW.id;</span>
|
|
<span class="sd"> END;</span>
|
|
<span class="sd"> """</span>
|
|
<span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_perform_db_maintenace</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
|
|
<span class="sd">"""Perform database maintenance"""</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="sd">"""DELETE FROM config</span>
|
|
<span class="sd"> WHERE id < (</span>
|
|
<span class="sd"> SELECT MIN(id)</span>
|
|
<span class="sd"> FROM (SELECT id FROM config ORDER BY id DESC LIMIT 9)</span>
|
|
<span class="sd"> );</span>
|
|
<span class="sd"> """</span>
|
|
<span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span></div>
|
|
|
|
|
|
<span class="k">class</span> <span class="nc">ExportDBInMemory</span><span class="p">(</span><span class="n">ExportDB</span><span class="p">):</span>
|
|
<span class="sd">"""In memory version of ExportDB</span>
|
|
<span class="sd"> Copies the on-disk database into memory so it may be operated on without</span>
|
|
<span class="sd"> modifying the on-disk version</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dbfile</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">export_dir</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="sd">""" "Initialize ExportDBInMemory</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> dbfile (str): path to database file</span>
|
|
<span class="sd"> export_dir (str): path to export directory</span>
|
|
<span class="sd"> write_back (bool): whether to write changes back to disk when closing; if False (default), changes are not written to disk</span>
|
|
<span class="sd"> """</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_dbfile</span> <span class="o">=</span> <span class="n">dbfile</span> <span class="ow">or</span> <span class="sa">f</span><span class="s2">"./</span><span class="si">{</span><span class="n">OSXPHOTOS_EXPORT_DB</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="c1"># export_dir is required as all files referenced by get_/set_uuid_for_file will be converted to</span>
|
|
<span class="c1"># relative paths to this path</span>
|
|
<span class="c1"># this allows the entire export tree to be moved to a new disk/location</span>
|
|
<span class="c1"># whilst preserving the UUID to filename mapping</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">export_dir</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_open_export_db</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_dbfile</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_insert_run_info</span><span class="p">()</span>
|
|
|
|
<span class="nd">@retry</span><span class="p">(</span><span class="n">stop</span><span class="o">=</span><span class="n">stop_after_attempt</span><span class="p">(</span><span class="n">MAX_RETRY_ATTEMPTS</span><span class="p">))</span>
|
|
<span class="k">def</span> <span class="nf">write_to_disk</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Write changes from in-memory database back to disk"""</span>
|
|
|
|
<span class="c1"># dump the database</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="n">dbdump</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dump_db</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
|
|
<span class="c1"># cleanup the old on-disk database</span>
|
|
<span class="c1"># also unlink the wal and shm files if needed</span>
|
|
<span class="n">dbfile</span> <span class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_dbfile</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">dbfile</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="n">dbfile</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span>
|
|
<span class="n">wal</span> <span class="o">=</span> <span class="n">dbfile</span><span class="o">.</span><span class="n">with_suffix</span><span class="p">(</span><span class="s2">".db-wal"</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">wal</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="n">wal</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span>
|
|
<span class="n">shm</span> <span class="o">=</span> <span class="n">dbfile</span><span class="o">.</span><span class="n">with_suffix</span><span class="p">(</span><span class="s2">".db-shm"</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">shm</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="n">shm</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span>
|
|
|
|
<span class="n">conn_on_disk</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">dbfile</span><span class="p">))</span>
|
|
<span class="n">conn_on_disk</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span><span class="o">.</span><span class="n">executescript</span><span class="p">(</span><span class="n">dbdump</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
|
|
<span class="n">conn_on_disk</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="n">conn_on_disk</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""close the database connection"""</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_open_export_db</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dbfile</span><span class="p">):</span> <span class="c1"># sourcery skip: raise-specific-error</span>
|
|
<span class="sd">"""open export database and return a db connection</span>
|
|
<span class="sd"> returns: connection to the database</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">dbfile</span><span class="p">):</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_db_connection</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">conn</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"Error getting connection to in-memory database"</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_create_or_migrate_db_tables</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">was_created</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">was_upgraded</span> <span class="o">=</span> <span class="p">()</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">dbfile</span><span class="p">)</span>
|
|
<span class="n">dbdump</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dump_db</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
|
|
|
|
<span class="c1"># Create a database in memory and import from the dump</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s2">":memory:"</span><span class="p">)</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span><span class="o">.</span><span class="n">executescript</span><span class="p">(</span><span class="n">dbdump</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">was_created</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="n">version_info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_database_version</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">version_info</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o"><</span> <span class="n">OSXPHOTOS_EXPORTDB_VERSION</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_create_or_migrate_db_tables</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">was_upgraded</span> <span class="o">=</span> <span class="p">(</span><span class="n">version_info</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">OSXPHOTOS_EXPORTDB_VERSION</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">was_upgraded</span> <span class="o">=</span> <span class="p">()</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">=</span> <span class="n">OSXPHOTOS_EXPORTDB_VERSION</span>
|
|
|
|
<span class="k">return</span> <span class="n">conn</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_get_db_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""return db connection to in memory database"""</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s2">":memory:"</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="k">return</span> <span class="n">conn</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_dump_db</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">:</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Connection</span><span class="p">)</span> <span class="o">-></span> <span class="n">StringIO</span><span class="p">:</span>
|
|
<span class="sd">"""dump sqlite db to a string buffer"""</span>
|
|
<span class="n">dbdump</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">()</span>
|
|
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">conn</span><span class="o">.</span><span class="n">iterdump</span><span class="p">():</span>
|
|
<span class="n">dbdump</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
|
|
<span class="n">dbdump</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">dbdump</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""close the database connection"""</span>
|
|
<span class="k">with</span> <span class="n">suppress</span><span class="p">(</span><span class="n">Error</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
|
|
|
|
|
|
<span class="k">class</span> <span class="nc">ExportDBTemp</span><span class="p">(</span><span class="n">ExportDBInMemory</span><span class="p">):</span>
|
|
<span class="sd">"""Temporary in-memory version of ExportDB"""</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_temp_dir</span> <span class="o">=</span> <span class="n">TemporaryDirectory</span><span class="p">()</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_dbfile</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_temp_dir</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">OSXPHOTOS_EXPORT_DB</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_temp_dir</span><span class="o">.</span><span class="n">name</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_open_export_db</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_dbfile</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_insert_run_info</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_relative_filepath</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filepath</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">])</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<span class="sd">"""Overrides _relative_filepath to return a path for use in the temp db"""</span>
|
|
<span class="n">filepath</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">filepath</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">filepath</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"/"</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">filepath</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
|
|
<span class="k">return</span> <span class="n">filepath</span>
|
|
|
|
|
|
<span class="k">class</span> <span class="nc">ExportRecord</span><span class="p">:</span>
|
|
<span class="sd">"""ExportRecord class"""</span>
|
|
|
|
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="s2">"_conn"</span><span class="p">,</span>
|
|
<span class="s2">"_context_manager"</span><span class="p">,</span>
|
|
<span class="s2">"_filepath_normalized"</span><span class="p">,</span>
|
|
<span class="p">]</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">,</span> <span class="n">filepath_normalized</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conn</span> <span class="o">=</span> <span class="n">conn</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span> <span class="o">=</span> <span class="n">filepath_normalized</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_context_manager</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">filepath</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""return filepath"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">row</span> <span class="o">:=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT filepath FROM export_data WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">,),</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
|
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"No filepath found in database for </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">filepath_normalized</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""return filepath_normalized"""</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">uuid</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""return uuid"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">row</span> <span class="o">:=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT uuid FROM export_data WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">,),</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
|
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"No uuid found in database for </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">digest</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""returns the digest value"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">row</span> <span class="o">:=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT digest FROM export_data WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">,),</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
|
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"No digest found in database for </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
|
|
<span class="nd">@digest</span><span class="o">.</span><span class="n">setter</span>
|
|
<span class="k">def</span> <span class="nf">digest</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="sd">"""set digest value"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"UPDATE export_data SET digest = ? WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_context_manager</span><span class="p">:</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">exifdata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""returns exifdata value for record"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">row</span> <span class="o">:=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT exifdata FROM export_data WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">,),</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
|
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"No exifdata found in database for </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="nd">@exifdata</span><span class="o">.</span><span class="n">setter</span>
|
|
<span class="k">def</span> <span class="nf">exifdata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="sd">"""set exifdata value"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"UPDATE export_data SET exifdata = ? WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span>
|
|
<span class="n">value</span><span class="p">,</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_context_manager</span><span class="p">:</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">src_sig</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""return source file signature value"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">row</span> <span class="o">:=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT src_mode, src_size, src_mtime FROM export_data WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">,),</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">():</span>
|
|
<span class="n">mtime</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span> <span class="k">if</span> <span class="n">row</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span>
|
|
<span class="k">return</span> <span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">mtime</span><span class="p">)</span>
|
|
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"No src_sig found in database for </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="nd">@src_sig</span><span class="o">.</span><span class="n">setter</span>
|
|
<span class="k">def</span> <span class="nf">src_sig</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="sd">"""set source file signature value"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"UPDATE export_data SET src_mode = ?, src_size = ?, src_mtime = ? WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span>
|
|
<span class="n">value</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span>
|
|
<span class="n">value</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span>
|
|
<span class="n">value</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_context_manager</span><span class="p">:</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">dest_sig</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""return destination file signature"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">row</span> <span class="o">:=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT dest_mode, dest_size, dest_mtime FROM export_data WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">,),</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">():</span>
|
|
<span class="n">mtime</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span> <span class="k">if</span> <span class="n">row</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span>
|
|
<span class="k">return</span> <span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">mtime</span><span class="p">)</span>
|
|
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"No dest_sig found in database for </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="nd">@dest_sig</span><span class="o">.</span><span class="n">setter</span>
|
|
<span class="k">def</span> <span class="nf">dest_sig</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="sd">"""set destination file signature"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"UPDATE export_data SET dest_mode = ?, dest_size = ?, dest_mtime = ? WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span>
|
|
<span class="n">value</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span>
|
|
<span class="n">value</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span>
|
|
<span class="n">value</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">,</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_context_manager</span><span class="p">:</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">photoinfo</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Returns info value"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">row</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT photoinfo from photoinfo where uuid = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">uuid</span><span class="p">,),</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">row</span> <span class="k">else</span> <span class="kc">None</span>
|
|
|
|
<span class="nd">@photoinfo</span><span class="o">.</span><span class="n">setter</span>
|
|
<span class="k">def</span> <span class="nf">photoinfo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="sd">"""Sets info value"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"INSERT OR REPLACE INTO photoinfo (uuid, photoinfo) VALUES (?, ?);"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">uuid</span><span class="p">,</span> <span class="n">value</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_context_manager</span><span class="p">:</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">export_options</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Get export_options value"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">row</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT export_options from export_data where filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">,),</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">row</span> <span class="k">else</span> <span class="kc">None</span>
|
|
|
|
<span class="nd">@export_options</span><span class="o">.</span><span class="n">setter</span>
|
|
<span class="k">def</span> <span class="nf">export_options</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="sd">"""Set export_options value"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"UPDATE export_data SET export_options = ? WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_context_manager</span><span class="p">:</span>
|
|
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">timestamp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""returns the timestamp value"""</span>
|
|
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
|
|
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">row</span> <span class="o">:=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
|
|
<span class="s2">"SELECT timestamp FROM export_data WHERE filepath_normalized = ?;"</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="p">,),</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
|
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"No timestamp found in database for </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_filepath_normalized</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">asdict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Return dict of self"""</span>
|
|
<span class="n">exifdata</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">exifdata</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">exifdata</span> <span class="k">else</span> <span class="kc">None</span>
|
|
<span class="n">photoinfo</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">photoinfo</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">photoinfo</span> <span class="k">else</span> <span class="kc">None</span>
|
|
<span class="k">return</span> <span class="p">{</span>
|
|
<span class="s2">"filepath"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">filepath</span><span class="p">,</span>
|
|
<span class="s2">"filepath_normalized"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">filepath_normalized</span><span class="p">,</span>
|
|
<span class="s2">"uuid"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">uuid</span><span class="p">,</span>
|
|
<span class="s2">"timestamp"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span><span class="p">,</span>
|
|
<span class="s2">"digest"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">digest</span><span class="p">,</span>
|
|
<span class="s2">"src_sig"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">src_sig</span><span class="p">,</span>
|
|
<span class="s2">"dest_sig"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_sig</span><span class="p">,</span>
|
|
<span class="s2">"export_options"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">export_options</span><span class="p">,</span>
|
|
<span class="s2">"exifdata"</span><span class="p">:</span> <span class="n">exifdata</span><span class="p">,</span>
|
|
<span class="s2">"photoinfo"</span><span class="p">:</span> <span class="n">photoinfo</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">def</span> <span class="nf">json</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="sd">"""Return json of self"""</span>
|
|
<span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">asdict</span><span class="p">(),</span> <span class="n">indent</span><span class="o">=</span><span class="n">indent</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_context_manager</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="k">return</span> <span class="bp">self</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">traceback</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="n">exc_type</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conn</span><span class="o">.</span><span class="n">rollback</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">_conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_context_manager</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</pre></div>
|
|
</article>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="related-pages">
|
|
|
|
|
|
</div>
|
|
<div class="bottom-of-page">
|
|
<div class="left-details">
|
|
<div class="copyright">
|
|
Copyright © 2021, Rhet Turnbull
|
|
</div>
|
|
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
|
|
|
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
|
|
|
</div>
|
|
<div class="right-details">
|
|
<div class="icons">
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</footer>
|
|
</div>
|
|
<aside class="toc-drawer no-toc">
|
|
|
|
|
|
|
|
</aside>
|
|
</div>
|
|
</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
|
|
<script src="../../_static/jquery.js"></script>
|
|
<script src="../../_static/underscore.js"></script>
|
|
<script src="../../_static/doctools.js"></script>
|
|
<script src="../../_static/scripts/furo.js"></script>
|
|
<script src="../../_static/clipboard.min.js"></script>
|
|
<script src="../../_static/copybutton.js"></script>
|
|
</body>
|
|
</html> |