vassili/seitime-frappe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4
seitime-frappe/docs/_build/html/_modules/webnotes/utils/nestedset.html
Rushabh Mehta b624972f0d added new docs
2011-06-29 14:41:49 +05:30

178 lines
No EOL
20 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>webnotes.utils.nestedset &mdash; WNFramework v1.8 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="WNFramework v1.8 documentation" href="../../../index.html" />
<link rel="up" title="webnotes.utils" href="../utils.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../index.html">WNFramework v1.8 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Module code</a> &raquo;</li>
<li><a href="../../webnotes.html" >webnotes</a> &raquo;</li>
<li><a href="../utils.html" accesskey="U">webnotes.utils</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for webnotes.utils.nestedset</h1><div class="highlight"><pre>
<span class="c"># Tree (Hierarchical) Nested Set Model (nsm)</span>
<span class="c"># </span>
<span class="c"># To use the nested set model,</span>
<span class="c"># use the following pattern</span>
<span class="c"># 1. name your parent field as &quot;parent_node&quot; if not have a property nsm_parent_field as your field name in the document class</span>
<span class="c"># 2. have a field called &quot;old_parent&quot; in your fields list - this identifies whether the parent has been changed</span>
<span class="c"># 3. call update_nsm(doc_obj) in the on_upate method</span>
<span class="c"># ------------------------------------------</span>
<span class="kn">import</span> <span class="nn">webnotes</span>
<span class="c"># called in the on_update method</span>
<div class="viewcode-block" id="update_nsm"><a class="viewcode-back" href="../../../webnotes.utils.html#webnotes.utils.nestedset.update_nsm">[docs]</a><span class="k">def</span> <span class="nf">update_nsm</span><span class="p">(</span><span class="n">doc_obj</span><span class="p">):</span>
<span class="c"># get fields, data from the DocType</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">doc_obj</span><span class="o">.</span><span class="n">doc</span>
<span class="n">pf</span><span class="p">,</span> <span class="n">opf</span> <span class="o">=</span> <span class="s">&#39;parent_node&#39;</span><span class="p">,</span> <span class="s">&#39;old_parent&#39;</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">doc_obj</span><span class="p">,</span><span class="s">&#39;nsm_parent_field&#39;</span><span class="p">):</span>
<span class="n">pf</span> <span class="o">=</span> <span class="n">doc_obj</span><span class="o">.</span><span class="n">nsm_parent_field</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">doc_obj</span><span class="p">,</span><span class="s">&#39;nsm_oldparent_field&#39;</span><span class="p">):</span>
<span class="n">opf</span> <span class="o">=</span> <span class="n">doc_obj</span><span class="o">.</span><span class="n">nsm_oldparent_field</span>
<span class="n">p</span><span class="p">,</span> <span class="n">op</span> <span class="o">=</span> <span class="n">d</span><span class="o">.</span><span class="n">fields</span><span class="p">[</span><span class="n">pf</span><span class="p">],</span> <span class="n">d</span><span class="o">.</span><span class="n">fields</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">opf</span><span class="p">,</span> <span class="s">&#39;&#39;</span><span class="p">)</span>
<span class="c"># has parent changed (?) or parent is None (root)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">doc_obj</span><span class="o">.</span><span class="n">doc</span><span class="o">.</span><span class="n">lft</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">doc_obj</span><span class="o">.</span><span class="n">doc</span><span class="o">.</span><span class="n">rgt</span><span class="p">:</span>
<span class="n">update_add_node</span><span class="p">(</span><span class="n">doc_obj</span><span class="o">.</span><span class="n">doc</span><span class="o">.</span><span class="n">doctype</span><span class="p">,</span> <span class="n">doc_obj</span><span class="o">.</span><span class="n">doc</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">p</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span><span class="p">,</span> <span class="n">pf</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">op</span> <span class="o">!=</span> <span class="n">p</span><span class="p">:</span>
<span class="n">update_remove_node</span><span class="p">(</span><span class="n">doc_obj</span><span class="o">.</span><span class="n">doc</span><span class="o">.</span><span class="n">doctype</span><span class="p">,</span> <span class="n">doc_obj</span><span class="o">.</span><span class="n">doc</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="n">update_add_node</span><span class="p">(</span><span class="n">doc_obj</span><span class="o">.</span><span class="n">doc</span><span class="o">.</span><span class="n">doctype</span><span class="p">,</span> <span class="n">doc_obj</span><span class="o">.</span><span class="n">doc</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">p</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span><span class="p">,</span> <span class="n">pf</span><span class="p">)</span>
<span class="c"># set old parent</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">opf</span><span class="p">,</span> <span class="n">p</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="rebuild_tree"><a class="viewcode-back" href="../../../webnotes.utils.html#webnotes.utils.nestedset.rebuild_tree">[docs]</a><span class="k">def</span> <span class="nf">rebuild_tree</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">parent_field</span><span class="p">):</span>
<span class="c"># get all roots</span>
<span class="n">right</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;SELECT name FROM `tab</span><span class="si">%s</span><span class="s">` WHERE `</span><span class="si">%s</span><span class="s">`=&#39;&#39; or `</span><span class="si">%s</span><span class="s">` IS NULL&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">parent_field</span><span class="p">,</span> <span class="n">parent_field</span><span class="p">))</span>
<span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">result</span><span class="p">:</span>
<span class="n">right</span> <span class="o">=</span> <span class="n">rebuild_node</span><span class="p">(</span><span class="n">doctype</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="n">right</span><span class="p">,</span> <span class="n">parent_field</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="rebuild_node"><a class="viewcode-back" href="../../../webnotes.utils.html#webnotes.utils.nestedset.rebuild_node">[docs]</a><span class="k">def</span> <span class="nf">rebuild_node</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">left</span><span class="p">,</span> <span class="n">parent_field</span><span class="p">):</span>
<span class="c"># the right value of this node is the left value + 1</span>
<span class="n">right</span> <span class="o">=</span> <span class="n">left</span><span class="o">+</span><span class="mi">1</span>
<span class="c"># get all children of this node</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;SELECT name FROM `tab</span><span class="si">%s</span><span class="s">` WHERE `</span><span class="si">%s</span><span class="s">`=&#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">parent_field</span><span class="p">,</span> <span class="n">parent</span><span class="p">))</span>
<span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">result</span><span class="p">:</span>
<span class="n">right</span> <span class="o">=</span> <span class="n">rebuild_node</span><span class="p">(</span><span class="n">doctype</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="n">right</span><span class="p">,</span> <span class="n">parent_field</span><span class="p">)</span>
<span class="c"># we&#39;ve got the left value, and now that we&#39;ve processed</span>
<span class="c"># the children of this node we also know the right value</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&#39;UPDATE `tab</span><span class="si">%s</span><span class="s">` SET lft=</span><span class="si">%s</span><span class="s">, rgt=</span><span class="si">%s</span><span class="s"> WHERE name=&quot;</span><span class="si">%s</span><span class="s">&quot;&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">doctype</span><span class="p">,</span><span class="n">left</span><span class="p">,</span><span class="n">right</span><span class="p">,</span><span class="n">parent</span><span class="p">))</span>
<span class="c">#return the right value of this node + 1</span>
<span class="k">return</span> <span class="n">right</span><span class="o">+</span><span class="mi">1</span>
</div>
<div class="viewcode-block" id="update_add_node"><a class="viewcode-back" href="../../../webnotes.utils.html#webnotes.utils.nestedset.update_add_node">[docs]</a><span class="k">def</span> <span class="nf">update_add_node</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">parent_field</span><span class="p">):</span>
<span class="c"># get the last sibling of the parent</span>
<span class="k">if</span> <span class="n">parent</span><span class="p">:</span>
<span class="n">right</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;select rgt from `tab</span><span class="si">%s</span><span class="s">` where name=&#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">parent</span><span class="p">))[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span> <span class="c"># root</span>
<span class="n">right</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;select ifnull(max(rgt),0)+1 from `tab</span><span class="si">%s</span><span class="s">` where ifnull(`</span><span class="si">%s</span><span class="s">`,&#39;&#39;) =&#39;&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">parent_field</span><span class="p">))[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="n">right</span> <span class="o">=</span> <span class="n">right</span> <span class="ow">or</span> <span class="mi">1</span>
<span class="c"># update all on the right</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;update `tab</span><span class="si">%s</span><span class="s">` set rgt = rgt+2 where rgt &gt;= </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span><span class="n">right</span><span class="p">))</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;update `tab</span><span class="si">%s</span><span class="s">` set lft = lft+2 where lft &gt;= </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span><span class="n">right</span><span class="p">))</span>
<span class="c">#$ update index of new node</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;update `tab</span><span class="si">%s</span><span class="s">` set lft=</span><span class="si">%s</span><span class="s">, rgt=</span><span class="si">%s</span><span class="s"> where name=&#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">doctype</span><span class="p">,</span><span class="n">right</span><span class="p">,</span><span class="n">right</span><span class="o">+</span><span class="mi">1</span><span class="p">,</span><span class="n">name</span><span class="p">))</span>
<span class="k">return</span> <span class="n">right</span>
</div>
<div class="viewcode-block" id="update_remove_node"><a class="viewcode-back" href="../../../webnotes.utils.html#webnotes.utils.nestedset.update_remove_node">[docs]</a><span class="k">def</span> <span class="nf">update_remove_node</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="n">left</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;select lft from `tab</span><span class="si">%s</span><span class="s">` where name=&#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">doctype</span><span class="p">,</span><span class="n">name</span><span class="p">))</span>
<span class="k">if</span> <span class="n">left</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]:</span>
<span class="c"># reset this node</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;update `tab</span><span class="si">%s</span><span class="s">` set lft=0, rgt=0 where name=&#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">doctype</span><span class="p">,</span><span class="n">name</span><span class="p">))</span>
<span class="c"># update all on the right</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;update `tab</span><span class="si">%s</span><span class="s">` set rgt = rgt-2 where rgt &gt; </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span><span class="n">left</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]))</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s">&quot;update `tab</span><span class="si">%s</span><span class="s">` set lft = lft-2 where lft &gt; </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span><span class="p">(</span><span class="n">doctype</span><span class="p">,</span><span class="n">left</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]))</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../index.html">
<img class="logo" src="../../../_static/wnflogo200.gif" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../index.html">WNFramework v1.8 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Module code</a> &raquo;</li>
<li><a href="../../webnotes.html" >webnotes</a> &raquo;</li>
<li><a href="../utils.html" >webnotes.utils</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink