seitime-frappe/docs/_build/html/_modules/webnotes/widgets/search.html
2011-06-29 14:41:49 +05:30

197 lines
No EOL
25 KiB
HTML

<!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.widgets.search &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" href="../../webnotes.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" accesskey="U">webnotes</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for webnotes.widgets.search</h1><div class="highlight"><pre>
<span class="c"># Search</span>
<span class="kn">import</span> <span class="nn">webnotes</span>
<span class="c"># this is called when a new doctype is setup for search - to set the filters</span>
<div class="viewcode-block" id="getsearchfields"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.search.getsearchfields">[docs]</a><span class="k">def</span> <span class="nf">getsearchfields</span><span class="p">():</span>
<span class="n">sf</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 search_fields from tabDocType where name=</span><span class="si">%s</span><span class="s">&quot;</span><span class="p">,</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&quot;doctype&quot;</span><span class="p">))</span>
<span class="n">sf</span> <span class="o">=</span> <span class="n">sf</span> <span class="ow">and</span> <span class="n">sf</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="ow">or</span> <span class="s">&#39;&#39;</span>
<span class="n">sf</span> <span class="o">=</span> <span class="p">[</span><span class="n">s</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">sf</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;,&#39;</span><span class="p">)]</span>
<span class="k">if</span> <span class="n">sf</span> <span class="ow">and</span> <span class="n">sf</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
<span class="n">res</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 fieldname, label, fieldtype, options from tabDocField where parent=&#39;</span><span class="si">%s</span><span class="s">&#39; and fieldname in (</span><span class="si">%s</span><span class="s">)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&quot;doctype&quot;</span><span class="p">,</span><span class="s">&quot;_NA&quot;</span><span class="p">),</span> <span class="s">&#39;&quot;&#39;</span><span class="o">+</span><span class="s">&#39;&quot;,&quot;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">sf</span><span class="p">)</span><span class="o">+</span><span class="s">&#39;&quot;&#39;</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">[[</span><span class="n">c</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">r</span><span class="p">]</span> <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">res</span><span class="p">]</span>
<span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
<span class="k">if</span> <span class="n">r</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="o">==</span><span class="s">&#39;Select&#39;</span> <span class="ow">and</span> <span class="n">r</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="ow">and</span> <span class="n">r</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">&#39;link:&#39;</span><span class="p">):</span>
<span class="n">dt</span> <span class="o">=</span> <span class="n">r</span><span class="p">[</span><span class="mi">3</span><span class="p">][</span><span class="mi">5</span><span class="p">:]</span>
<span class="n">ol</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 docstatus!=2 order by name asc&quot;</span> <span class="o">%</span> <span class="n">dt</span><span class="p">)</span>
<span class="n">r</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;</span><span class="se">\n</span><span class="s">&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s">&#39;&#39;</span><span class="p">]</span> <span class="o">+</span> <span class="p">[</span><span class="n">o</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">o</span> <span class="ow">in</span> <span class="n">ol</span><span class="p">])</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s">&#39;searchfields&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[[</span><span class="s">&#39;name&#39;</span><span class="p">,</span> <span class="s">&#39;ID&#39;</span><span class="p">,</span> <span class="s">&#39;Data&#39;</span><span class="p">,</span> <span class="s">&#39;&#39;</span><span class="p">]]</span> <span class="o">+</span> <span class="n">res</span>
</div>
<div class="viewcode-block" id="make_query"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.search.make_query">[docs]</a><span class="k">def</span> <span class="nf">make_query</span><span class="p">(</span><span class="n">fields</span><span class="p">,</span> <span class="n">dt</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">txt</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">length</span><span class="p">):</span>
<span class="k">return</span> <span class="s">&quot;&quot;&quot;SELECT </span><span class="si">%(fields)s</span><span class="s"> </span>
<span class="s"> FROM `tab</span><span class="si">%(dt)s</span><span class="s">` </span>
<span class="s"> WHERE `tab</span><span class="si">%(dt)s</span><span class="s">`.`</span><span class="si">%(key)s</span><span class="s">` LIKE &#39;</span><span class="si">%(txt)s</span><span class="s">&#39; AND `tab</span><span class="si">%(dt)s</span><span class="s">`.docstatus != 2</span>
<span class="s"> ORDER BY `tab</span><span class="si">%(dt)s</span><span class="s">`.`</span><span class="si">%(key)s</span><span class="s">` </span>
<span class="s"> DESC LIMIT </span><span class="si">%(start)s</span><span class="s">, </span><span class="si">%(len)s</span><span class="s"> &quot;&quot;&quot;</span> <span class="o">%</span> <span class="p">{</span>
<span class="s">&#39;fields&#39;</span><span class="p">:</span> <span class="n">fields</span><span class="p">,</span>
<span class="s">&#39;dt&#39;</span><span class="p">:</span> <span class="n">dt</span><span class="p">,</span>
<span class="s">&#39;key&#39;</span><span class="p">:</span> <span class="n">key</span><span class="p">,</span>
<span class="s">&#39;txt&#39;</span><span class="p">:</span> <span class="n">txt</span> <span class="o">+</span> <span class="s">&#39;%&#39;</span><span class="p">,</span>
<span class="s">&#39;start&#39;</span><span class="p">:</span> <span class="n">start</span><span class="p">,</span>
<span class="s">&#39;len&#39;</span><span class="p">:</span> <span class="n">length</span>
<span class="p">}</span>
</div>
<div class="viewcode-block" id="get_std_fields_list"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.search.get_std_fields_list">[docs]</a><span class="k">def</span> <span class="nf">get_std_fields_list</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="c"># get additional search fields</span>
<span class="n">sflist</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 search_fields from tabDocType where name = &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">dt</span><span class="p">)</span>
<span class="n">sflist</span> <span class="o">=</span> <span class="n">sflist</span> <span class="ow">and</span> <span class="n">sflist</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="ow">and</span> <span class="n">sflist</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="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;,&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="p">[]</span>
<span class="n">sflist</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;name&#39;</span><span class="p">]</span> <span class="o">+</span> <span class="n">sflist</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">sflist</span><span class="p">:</span>
<span class="n">sflist</span> <span class="o">=</span> <span class="n">sflist</span> <span class="o">+</span> <span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="k">return</span> <span class="p">[</span><span class="s">&#39;`tab</span><span class="si">%s</span><span class="s">`.`</span><span class="si">%s</span><span class="s">`&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">f</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">sflist</span><span class="p">]</span>
</div>
<div class="viewcode-block" id="build_for_autosuggest"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.search.build_for_autosuggest">[docs]</a><span class="k">def</span> <span class="nf">build_for_autosuggest</span><span class="p">(</span><span class="n">res</span><span class="p">):</span>
<span class="kn">from</span> <span class="nn">webnotes.utils</span> <span class="kn">import</span> <span class="n">cstr</span>
<span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
<span class="n">info</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">r</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">info</span> <span class="o">=</span> <span class="s">&#39;,&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">cstr</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">r</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">info</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">30</span><span class="p">:</span>
<span class="n">info</span> <span class="o">=</span> <span class="n">info</span><span class="p">[:</span><span class="mi">30</span><span class="p">]</span> <span class="o">+</span> <span class="s">&#39;...&#39;</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s">&#39;id&#39;</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="s">&#39;value&#39;</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="s">&#39;info&#39;</span><span class="p">:</span><span class="n">info</span><span class="p">})</span>
<span class="k">return</span> <span class="n">results</span>
</div>
<div class="viewcode-block" id="scrub_custom_query"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.search.scrub_custom_query">[docs]</a><span class="k">def</span> <span class="nf">scrub_custom_query</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">txt</span><span class="p">):</span>
<span class="k">if</span> <span class="s">&#39;</span><span class="si">%(key)s</span><span class="s">&#39;</span> <span class="ow">in</span> <span class="n">query</span><span class="p">:</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%(key)s</span><span class="s">&#39;</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span>
<span class="k">if</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span> <span class="ow">in</span> <span class="n">query</span><span class="p">:</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="p">,</span> <span class="p">((</span><span class="n">txt</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;%&#39;</span><span class="p">))</span>
<span class="k">return</span> <span class="n">query</span>
<span class="c"># this is called by the Link Field</span></div>
<div class="viewcode-block" id="search_link"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.search.search_link">[docs]</a><span class="k">def</span> <span class="nf">search_link</span><span class="p">():</span>
<span class="kn">import</span> <span class="nn">webnotes.widgets.query_builder</span>
<span class="n">txt</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;txt&#39;</span><span class="p">)</span>
<span class="n">dt</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;dt&#39;</span><span class="p">)</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;query&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">query</span><span class="p">:</span>
<span class="n">res</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="n">scrub_custom_query</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="s">&#39;name&#39;</span><span class="p">,</span> <span class="n">txt</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">q</span> <span class="o">=</span> <span class="n">make_query</span><span class="p">(</span><span class="s">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">get_std_fields_list</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="s">&#39;name&#39;</span><span class="p">)),</span> <span class="n">dt</span><span class="p">,</span> <span class="s">&#39;name&#39;</span><span class="p">,</span> <span class="n">txt</span><span class="p">,</span> <span class="s">&#39;0&#39;</span><span class="p">,</span> <span class="s">&#39;10&#39;</span><span class="p">)</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">widgets</span><span class="o">.</span><span class="n">query_builder</span><span class="o">.</span><span class="n">runquery</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">ret</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="c"># make output</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s">&#39;results&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">build_for_autosuggest</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="c"># this is called by the search box</span></div>
<div class="viewcode-block" id="search_widget"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.search.search_widget">[docs]</a><span class="k">def</span> <span class="nf">search_widget</span><span class="p">():</span>
<span class="kn">import</span> <span class="nn">webnotes.widgets.query_builder</span>
<span class="n">dt</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;doctype&#39;</span><span class="p">)</span>
<span class="n">txt</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;txt&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;searchfield&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&#39;name&#39;</span> <span class="c"># key field</span>
<span class="n">user_query</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;query&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span>
<span class="k">if</span> <span class="n">user_query</span><span class="p">:</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">scrub_custom_query</span><span class="p">(</span><span class="n">user_query</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">txt</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">make_query</span><span class="p">(</span><span class="s">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">get_std_fields_list</span><span class="p">(</span><span class="n">dt</span><span class="p">,</span> <span class="n">key</span><span class="p">)),</span> <span class="n">dt</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">txt</span><span class="p">,</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;start&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">,</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;page_len&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="mi">50</span><span class="p">)</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">widgets</span><span class="o">.</span><span class="n">query_builder</span><span class="o">.</span><span class="n">runquery</span><span class="p">(</span><span class="n">query</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>
</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>