644 lines
57 KiB
HTML
644 lines
57 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>binaryninja.pluginmanager — Binary Ninja API Documentation v1.1</title>
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../_static/css/other.css" type="text/css" />
|
|
|
|
|
|
|
|
<link rel="index" title="Index"
|
|
href="../../genindex.html"/>
|
|
<link rel="search" title="Search" href="../../search.html"/>
|
|
<link rel="top" title="Binary Ninja API Documentation v1.1" href="../../index.html"/>
|
|
<link rel="up" title="binaryninja" href="../binaryninja.html"/>
|
|
|
|
|
|
<script src="../../_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
<a href="../../index.html" class="icon icon-home"> Binary Ninja API
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
<script>
|
|
window.addEventListener("load", function() {
|
|
var ver = document.getElementsByClassName("version");
|
|
ver[0].innerHTML = DOCUMENTATION_OPTIONS['VERSION'];
|
|
});
|
|
</script>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.architecture-module.html">architecture</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.atexit-module.html">atexit</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.basicblock-module.html">basicblock</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.binaryview-module.html">binaryview</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.callingconvention-module.html">callingconvention</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.databuffer-module.html">databuffer</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.datarender-module.html">datarender</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.demangle-module.html">demangle</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.downloadprovider-module.html">downloadprovider</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.enums-module.html">enums</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.fileaccessor-module.html">fileaccessor</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.filemetadata-module.html">filemetadata</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.flowgraph-module.html">flowgraph</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.function-module.html">function</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.functionrecognizer-module.html">functionrecognizer</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.highlight-module.html">highlight</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.interaction-module.html">interaction</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.lineardisassembly-module.html">lineardisassembly</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.log-module.html">log</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.lowlevelil-module.html">lowlevelil</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.mainthread-module.html">mainthread</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.mediumlevelil-module.html">mediumlevelil</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.metadata-module.html">metadata</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.numbers-module.html">numbers</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.platform-module.html">platform</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.plugin-module.html">plugin</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.pluginmanager-module.html">pluginmanager</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.scriptingprovider-module.html">scriptingprovider</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.settings-module.html">settings</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.transform-module.html">transform</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.types-module.html">types</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.undoaction-module.html">undoaction</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../binaryninja.update-module.html">update</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../../index.html">Binary Ninja API</a>
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="../../index.html">Docs</a> »</li>
|
|
|
|
<li><a href="../index.html">Module code</a> »</li>
|
|
|
|
<li><a href="../binaryninja.html">binaryninja</a> »</li>
|
|
|
|
<li>binaryninja.pluginmanager</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<h1>Source code for binaryninja.pluginmanager</h1><div class="highlight"><pre>
|
|
<span></span><span class="c1"># Copyright (c) 2015-2019 Vector 35 Inc</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># Permission is hereby granted, free of charge, to any person obtaining a copy</span>
|
|
<span class="c1"># of this software and associated documentation files (the "Software"), to</span>
|
|
<span class="c1"># deal in the Software without restriction, including without limitation the</span>
|
|
<span class="c1"># rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span>
|
|
<span class="c1"># sell copies of the Software, and to permit persons to whom the Software is</span>
|
|
<span class="c1"># furnished to do so, subject to the following conditions:</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># The above copyright notice and this permission notice shall be included in</span>
|
|
<span class="c1"># all copies or substantial portions of the Software.</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
|
|
<span class="c1"># IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
|
|
<span class="c1"># FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
|
|
<span class="c1"># AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
|
|
<span class="c1"># LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span>
|
|
<span class="c1"># FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS</span>
|
|
<span class="c1"># IN THE SOFTWARE.</span>
|
|
|
|
<span class="kn">import</span> <span class="nn">ctypes</span>
|
|
|
|
<span class="c1"># Binary Ninja components</span>
|
|
<span class="kn">from</span> <span class="nn">binaryninja</span> <span class="k">import</span> <span class="n">_binaryninjacore</span> <span class="k">as</span> <span class="n">core</span>
|
|
|
|
<span class="c1"># 2-3 compatibility</span>
|
|
<span class="kn">from</span> <span class="nn">binaryninja</span> <span class="k">import</span> <span class="nb">range</span>
|
|
|
|
|
|
<div class="viewcode-block" id="RepoPlugin"><a class="viewcode-back" href="../../binaryninja.pluginmanager.RepoPlugin.html#binaryninja.pluginmanager.RepoPlugin">[docs]</a><span class="k">class</span> <span class="nc">RepoPlugin</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> ``RepoPlugin` is mostly read-only, however you can install/uninstall enable/disable plugins. RepoPlugins are</span>
|
|
<span class="sd"> created by parsing the plugins.json in a plugin repository.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="kn">from</span> <span class="nn">binaryninja.enums</span> <span class="k">import</span> <span class="n">PluginType</span><span class="p">,</span> <span class="n">PluginUpdateStatus</span>
|
|
<div class="viewcode-block" id="RepoPlugin.__init__"><a class="viewcode-back" href="../../binaryninja.pluginmanager.RepoPlugin.html#binaryninja.pluginmanager.RepoPlugin.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">handle</span><span class="p">):</span>
|
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"RepoPlugin temporarily disabled!"</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="o">=</span> <span class="n">core</span><span class="o">.</span><span class="n">handle_of_type</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepoPlugin</span><span class="p">)</span></div>
|
|
|
|
<span class="k">def</span> <span class="nf">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="n">core</span><span class="o">.</span><span class="n">BNFreePlugin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="s2">"<</span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">/</span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</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="s2">"installed"</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">installed</span> <span class="k">else</span> <span class="s2">"not-installed"</span><span class="p">,</span> <span class="s2">"enabled"</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span> <span class="k">else</span> <span class="s2">"disabled"</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">"""Relative path from the base of the repository to the actual plugin"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetPath</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">installed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Boolean True if the plugin is installed, False otherwise"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginIsInstalled</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@installed</span><span class="o">.</span><span class="n">setter</span>
|
|
<span class="k">def</span> <span class="nf">installed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="n">state</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginInstall</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginUninstall</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">enabled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Boolean True if the plugin is currently enabled, False otherwise"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginIsEnabled</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@enabled</span><span class="o">.</span><span class="n">setter</span>
|
|
<span class="k">def</span> <span class="nf">enabled</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="n">state</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginEnable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginDisable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">api</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""string indicating the API used by the plugin"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetApi</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">description</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String short description of the plugin"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetDescription</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">license</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String short license description (ie MIT, BSD, GPLv2, etc)"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetLicense</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">license_text</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String complete license text for the given plugin"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetLicenseText</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">long_description</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String long description of the plugin"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetLongdescription</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">minimum_version</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String minimum version the plugin was tested on"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetMinimimVersions</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String name of the plugin"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetName</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">plugin_types</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""List of PluginType enumeration objects indicating the plugin type(s)"""</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="n">count</span> <span class="o">=</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_ulonglong</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
|
<span class="n">plugintypes</span> <span class="o">=</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetPluginTypes</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">count</span><span class="p">)</span>
|
|
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">count</span><span class="o">.</span><span class="n">value</span><span class="p">):</span>
|
|
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">PluginType</span><span class="p">(</span><span class="n">plugintypes</span><span class="p">[</span><span class="n">i</span><span class="p">]))</span>
|
|
<span class="n">core</span><span class="o">.</span><span class="n">BNFreePluginTypes</span><span class="p">(</span><span class="n">plugintypes</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">result</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String URL of the plugin's git repository"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetUrl</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">version</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String version of the plugin"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetVersion</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">update_status</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""PluginUpdateStatus enumeration indicating if the plugin is up to date or not"""</span>
|
|
<span class="k">return</span> <span class="n">PluginUpdateStatus</span><span class="p">(</span><span class="n">core</span><span class="o">.</span><span class="n">BNPluginGetPluginUpdateStatus</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="Repository"><a class="viewcode-back" href="../../binaryninja.pluginmanager.Repository.html#binaryninja.pluginmanager.Repository">[docs]</a><span class="k">class</span> <span class="nc">Repository</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> ``Repository`` is a read-only class. Use RepositoryManager to Enable/Disable/Install/Uninstall plugins.</span>
|
|
<span class="sd"> """</span>
|
|
<div class="viewcode-block" id="Repository.__init__"><a class="viewcode-back" href="../../binaryninja.pluginmanager.Repository.html#binaryninja.pluginmanager.Repository.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">handle</span><span class="p">):</span>
|
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"Repository temporarily disabled!"</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="o">=</span> <span class="n">core</span><span class="o">.</span><span class="n">handle_of_type</span><span class="p">(</span><span class="n">handle</span><span class="p">,</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepository</span><span class="p">)</span></div>
|
|
|
|
<span class="k">def</span> <span class="nf">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="n">core</span><span class="o">.</span><span class="n">BNFreeRepository</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="s2">"<</span><span class="si">{}</span><span class="s2"> - </span><span class="si">{}</span><span class="s2">/</span><span class="si">{}</span><span class="s2">>"</span><span class="o">.</span><span class="n">format</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="bp">self</span><span class="o">.</span><span class="n">remote_reference</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">local_reference</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plugin_path</span><span class="p">):</span>
|
|
<span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugins</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">plugin_path</span> <span class="o">==</span> <span class="n">plugin</span><span class="o">.</span><span class="n">path</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">plugin</span>
|
|
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">()</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String URL of the git repository where the plugin repository's are stored"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryGetUrl</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</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">"""String local path to store the given plugin repository"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryGetRepoPath</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">full_path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String full path the repository"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryGetPluginsPath</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">local_reference</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String for the local git reference (ie 'master')"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryGetLocalReference</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">remote_reference</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""String for the remote git reference (ie 'origin')"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryGetRemoteReference</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">plugins</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""List of RepoPlugin objects contained within this repository"""</span>
|
|
<span class="n">pluginlist</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="n">count</span> <span class="o">=</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_ulonglong</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryGetPlugins</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">count</span><span class="p">)</span>
|
|
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">count</span><span class="o">.</span><span class="n">value</span><span class="p">):</span>
|
|
<span class="n">pluginlist</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">RepoPlugin</span><span class="p">(</span><span class="n">handle</span><span class="o">=</span><span class="n">result</span><span class="p">[</span><span class="n">i</span><span class="p">]))</span>
|
|
<span class="n">core</span><span class="o">.</span><span class="n">BNFreeRepositoryPluginList</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">count</span><span class="o">.</span><span class="n">value</span><span class="p">)</span>
|
|
<span class="k">del</span> <span class="n">result</span>
|
|
<span class="k">return</span> <span class="n">pluginlist</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">initialized</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Boolean True when the repository has been initialized"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryIsInitialized</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="RepositoryManager"><a class="viewcode-back" href="../../binaryninja.pluginmanager.RepositoryManager.html#binaryninja.pluginmanager.RepositoryManager">[docs]</a><span class="k">class</span> <span class="nc">RepositoryManager</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> ``RepositoryManager`` Keeps track of all the repositories and keeps the enabled_plugins.json file coherent with</span>
|
|
<span class="sd"> the plugins that are installed/uninstalled enabled/disabled</span>
|
|
<span class="sd"> """</span>
|
|
<div class="viewcode-block" id="RepositoryManager.__init__"><a class="viewcode-back" href="../../binaryninja.pluginmanager.RepositoryManager.html#binaryninja.pluginmanager.RepositoryManager.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">handle</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"RepositoryManager temporarily disabled!"</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="o">=</span> <span class="n">core</span><span class="o">.</span><span class="n">BNGetRepositoryManager</span><span class="p">()</span></div>
|
|
|
|
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">repo_path</span><span class="p">):</span>
|
|
<span class="k">for</span> <span class="n">repo</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">repositories</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">repo_path</span> <span class="o">==</span> <span class="n">repo</span><span class="o">.</span><span class="n">path</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">repo</span>
|
|
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">()</span>
|
|
|
|
<div class="viewcode-block" id="RepositoryManager.check_for_updates"><a class="viewcode-back" href="../../binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepositoryManager.check_for_updates">[docs]</a> <span class="k">def</span> <span class="nf">check_for_updates</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Check for updates for all managed Repository objects"""</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryManagerCheckForUpdates</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span></div>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">repositories</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""List of Repository objects being managed"""</span>
|
|
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="n">count</span> <span class="o">=</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_ulonglong</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
|
<span class="n">repos</span> <span class="o">=</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryManagerGetRepositories</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">count</span><span class="p">)</span>
|
|
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">count</span><span class="o">.</span><span class="n">value</span><span class="p">):</span>
|
|
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Repository</span><span class="p">(</span><span class="n">handle</span><span class="o">=</span><span class="n">repos</span><span class="p">[</span><span class="n">i</span><span class="p">]))</span>
|
|
<span class="n">core</span><span class="o">.</span><span class="n">BNFreeRepositoryManagerRepositoriesList</span><span class="p">(</span><span class="n">repos</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">result</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">plugins</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""List of all RepoPlugins in each repository"""</span>
|
|
<span class="n">plgs</span> <span class="o">=</span> <span class="p">{}</span>
|
|
<span class="k">for</span> <span class="n">repo</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">repositories</span><span class="p">:</span>
|
|
<span class="n">plgs</span><span class="p">[</span><span class="n">repo</span><span class="o">.</span><span class="n">path</span><span class="p">]</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">plugins</span>
|
|
<span class="k">return</span> <span class="n">plgs</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">default_repository</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Gets the default Repository"""</span>
|
|
<span class="n">binaryninja</span><span class="o">.</span><span class="n">_init_plugins</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="n">Repository</span><span class="p">(</span><span class="n">handle</span><span class="o">=</span><span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryManagerGetDefaultRepository</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">))</span>
|
|
|
|
<div class="viewcode-block" id="RepositoryManager.enable_plugin"><a class="viewcode-back" href="../../binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepositoryManager.enable_plugin">[docs]</a> <span class="k">def</span> <span class="nf">enable_plugin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plugin</span><span class="p">,</span> <span class="n">install</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> ``enable_plugin`` Enables the installed plugin 'plugin', optionally installing the plugin if `install` is set to</span>
|
|
<span class="sd"> True (default), and optionally using the non-default repository.</span>
|
|
|
|
<span class="sd"> :param str name: Name of the plugin to enable</span>
|
|
<span class="sd"> :param Boolean install: Optionally install the repo, defaults to True.</span>
|
|
<span class="sd"> :param str repo: Optional, specify a repository other than the default repository.</span>
|
|
<span class="sd"> :return: Boolean value True if the plugin was successfully enabled, False otherwise</span>
|
|
<span class="sd"> :rtype: Boolean</span>
|
|
<span class="sd"> :Example:</span>
|
|
|
|
<span class="sd"> >>> mgr = RepositoryManager()</span>
|
|
<span class="sd"> >>> mgr.enable_plugin('binaryninja-bookmarks')</span>
|
|
<span class="sd"> True</span>
|
|
<span class="sd"> >>></span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="n">install</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">install_plugin</span><span class="p">(</span><span class="n">plugin</span><span class="p">,</span> <span class="n">repo</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="kc">False</span>
|
|
|
|
<span class="k">if</span> <span class="n">repo</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="n">repo</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_repository</span>
|
|
<span class="n">repopath</span> <span class="o">=</span> <span class="n">repo</span>
|
|
<span class="n">pluginpath</span> <span class="o">=</span> <span class="n">plugin</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">repo</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="n">repopath</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">path</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">plugin</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="n">pluginpath</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">path</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryManagerEnablePlugin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">repopath</span><span class="p">,</span> <span class="n">pluginpath</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="RepositoryManager.disable_plugin"><a class="viewcode-back" href="../../binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepositoryManager.disable_plugin">[docs]</a> <span class="k">def</span> <span class="nf">disable_plugin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plugin</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> ``disable_plugin`` Disable the specified plugin, pluginpath</span>
|
|
|
|
<span class="sd"> :param Repository or str repo: Repository containing the plugin to disable</span>
|
|
<span class="sd"> :param RepoPlugin or str plugin: RepoPlugin to disable</span>
|
|
<span class="sd"> :return: Boolean value True if the plugin was successfully disabled, False otherwise</span>
|
|
<span class="sd"> :rtype: Boolean</span>
|
|
<span class="sd"> :Example:</span>
|
|
|
|
<span class="sd"> >>> mgr = RepositoryManager()</span>
|
|
<span class="sd"> >>> mgr.disable_plugin('binaryninja-bookmarks')</span>
|
|
<span class="sd"> True</span>
|
|
<span class="sd"> >>></span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="n">repo</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="n">repo</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_repository</span>
|
|
<span class="n">repopath</span> <span class="o">=</span> <span class="n">repo</span>
|
|
<span class="n">pluginpath</span> <span class="o">=</span> <span class="n">plugin</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">repo</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="n">repopath</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">path</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">plugin</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="n">pluginpath</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">path</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryManagerDisablePlugin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">repopath</span><span class="p">,</span> <span class="n">pluginpath</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="RepositoryManager.install_plugin"><a class="viewcode-back" href="../../binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepositoryManager.install_plugin">[docs]</a> <span class="k">def</span> <span class="nf">install_plugin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plugin</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> ``install_plugin`` install the specified plugin, pluginpath</span>
|
|
|
|
<span class="sd"> :param Repository or str repo: Repository containing the plugin to install</span>
|
|
<span class="sd"> :param RepoPlugin or str plugin: RepoPlugin to install</span>
|
|
<span class="sd"> :return: Boolean value True if the plugin was successfully installed, False otherwise</span>
|
|
<span class="sd"> :rtype: Boolean</span>
|
|
<span class="sd"> :Example:</span>
|
|
|
|
<span class="sd"> >>> mgr = RepositoryManager()</span>
|
|
<span class="sd"> >>> mgr.install_plugin('binaryninja-bookmarks')</span>
|
|
<span class="sd"> True</span>
|
|
<span class="sd"> >>></span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="n">repo</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="n">repo</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_repository</span>
|
|
<span class="n">repopath</span> <span class="o">=</span> <span class="n">repo</span>
|
|
<span class="n">pluginpath</span> <span class="o">=</span> <span class="n">plugin</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">repo</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="n">repopath</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">path</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">plugin</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="n">pluginpath</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">path</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryManagerInstallPlugin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">repopath</span><span class="p">,</span> <span class="n">pluginpath</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="RepositoryManager.uninstall_plugin"><a class="viewcode-back" href="../../binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepositoryManager.uninstall_plugin">[docs]</a> <span class="k">def</span> <span class="nf">uninstall_plugin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plugin</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> ``uninstall_plugin`` uninstall the specified plugin, pluginpath</span>
|
|
|
|
<span class="sd"> :param Repository or str repo: Repository containing the plugin to uninstall</span>
|
|
<span class="sd"> :param RepoPlugin or str plugin: RepoPlugin to uninstall</span>
|
|
<span class="sd"> :return: Boolean value True if the plugin was successfully uninstalled, False otherwise</span>
|
|
<span class="sd"> :rtype: Boolean</span>
|
|
<span class="sd"> :Example:</span>
|
|
|
|
<span class="sd"> >>> mgr = RepositoryManager()</span>
|
|
<span class="sd"> >>> mgr.uninstall_plugin('binaryninja-bookmarks')</span>
|
|
<span class="sd"> True</span>
|
|
<span class="sd"> >>></span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="n">repo</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="n">repo</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_repository</span>
|
|
<span class="n">repopath</span> <span class="o">=</span> <span class="n">repo</span>
|
|
<span class="n">pluginpath</span> <span class="o">=</span> <span class="n">plugin</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">repo</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="n">repopath</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">path</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">plugin</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="n">pluginpath</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">path</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryManagerUninstallPlugin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">repopath</span><span class="p">,</span> <span class="n">pluginpath</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="RepositoryManager.update_plugin"><a class="viewcode-back" href="../../binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepositoryManager.update_plugin">[docs]</a> <span class="k">def</span> <span class="nf">update_plugin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plugin</span><span class="p">,</span> <span class="n">repo</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> ``update_plugin`` update the specified plugin, pluginpath</span>
|
|
|
|
<span class="sd"> :param Repository or str repo: Repository containing the plugin to update</span>
|
|
<span class="sd"> :param RepoPlugin or str plugin: RepoPlugin to update</span>
|
|
<span class="sd"> :return: Boolean value True if the plugin was successfully updated, False otherwise</span>
|
|
<span class="sd"> :rtype: Boolean</span>
|
|
<span class="sd"> :Example:</span>
|
|
|
|
<span class="sd"> >>> mgr = RepositoryManager()</span>
|
|
<span class="sd"> >>> mgr.update_plugin('binaryninja-bookmarks')</span>
|
|
<span class="sd"> True</span>
|
|
<span class="sd"> >>></span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="n">repo</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="n">repo</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_repository</span>
|
|
<span class="n">repopath</span> <span class="o">=</span> <span class="n">repo</span>
|
|
<span class="n">pluginpath</span> <span class="o">=</span> <span class="n">plugin</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">repo</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="n">repopath</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">path</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">plugin</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="n">pluginpath</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">path</span>
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryManagerUpdatePlugin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">repopath</span><span class="p">,</span> <span class="n">pluginpath</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="RepositoryManager.add_repository"><a class="viewcode-back" href="../../binaryninja.pluginmanager-module.html#binaryninja.pluginmanager.RepositoryManager.add_repository">[docs]</a> <span class="k">def</span> <span class="nf">add_repository</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">repopath</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">localreference</span><span class="o">=</span><span class="s2">"master"</span><span class="p">,</span> <span class="n">remotereference</span><span class="o">=</span><span class="s2">"origin"</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> ``add_repository`` adds a new plugin repository for the manager to track.</span>
|
|
|
|
<span class="sd"> :param str url: URL to the git repository where the plugins are stored.</span>
|
|
<span class="sd"> :param str repopath: path to where the repository will be stored on disk locally</span>
|
|
<span class="sd"> :param str localreference: Optional reference to the local tracking branch typically "master"</span>
|
|
<span class="sd"> :param str remotereference: Optional reference to the remote tracking branch typically "origin"</span>
|
|
<span class="sd"> :return: Boolean value True if the repository was successfully added, False otherwise.</span>
|
|
<span class="sd"> :rtype: Boolean</span>
|
|
<span class="sd"> :Example:</span>
|
|
|
|
<span class="sd"> >>> mgr = RepositoryManager()</span>
|
|
<span class="sd"> >>> mgr.add_repository(url="https://github.com/vector35/community-plugins.git",</span>
|
|
<span class="sd"> repopath="myrepo",</span>
|
|
<span class="sd"> localreference="master", remotereference="origin")</span>
|
|
<span class="sd"> True</span>
|
|
<span class="sd"> >>></span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">repopath</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span>
|
|
<span class="nb">isinstance</span><span class="p">(</span><span class="n">localreference</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">remotereference</span><span class="p">,</span> <span class="nb">str</span><span class="p">)):</span>
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Parameter is incorrect type"</span><span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="n">core</span><span class="o">.</span><span class="n">BNRepositoryManagerAddRepository</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">repopath</span><span class="p">,</span> <span class="n">localreference</span><span class="p">,</span> <span class="n">remotereference</span><span class="p">)</span></div></div>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2015-2019, Vector 35 Inc.
|
|
|
|
</p>
|
|
</div>
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
|
<script type="text/javascript" src="../../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../../_static/doctools.js"></script>
|
|
<script type="text/javascript" src="../../_static/language_data.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="../../_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |