├── LICENSE ├── README.md └── zzzfoo /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | zzzfoo: Desktop file search with Rofi and Recoll 2 | ================================================ 3 | 4 | This script lets you combine the excellent full-text search tool [Recoll](https://www.lesbonscomptes.com/recoll/) 5 | with [Rofi](https://github.com/DaveDavenport/rofi) (popular dmenu replacement, 6 | among other things) to quickly search all your indexed files. It simply 7 | performs a Recoll search using Recoll's Python module, pipes the output to 8 | `rofi -dmenu`, and (optionally) does something with the selected match. 9 | 10 | If you only need file paths in your results, forget this script and just grep/sed 11 | the result of `recoll -t -e -b ` and pipe that into rofi or dmenu; this 12 | script is basically a one-liner that got out of hand. However, if you want 13 | titles and MIME types and highlighted extracts and colors, as well as 14 | various options, keep reading. 15 | 16 | WARNING: Still at version 0.x, use at your own risk, etc. 17 | 18 | ![zzzfoo screenshot](https://anders.unix.se/images/zzzfoo_01.png) 19 | 20 | ![zzzfoo screenshot](https://anders.unix.se/images/zzzfoo_02.png) 21 | 22 | Requirements 23 | ------------ 24 | 25 | * Python 3 26 | * [Recoll](https://www.lesbonscomptes.com/recoll/) (and its Python module), tested with 1.21/1.23 27 | * [Rofi](https://github.com/DaveDavenport/rofi) 1.3+ 28 | 29 | Many Linux distributions (as well as FreeBSD) package both Rofi and Recoll. For e.g. 30 | Debian/Ubuntu, install `rofi recoll python3-recoll`; for Arch, install `rofi recoll`. 31 | 32 | Note that Ubuntu 16.04 has Rofi 0.15.x which is very outdated. You need 1.3 or later. 33 | See Rofi's [installation guide](https://github.com/DaveDavenport/rofi/blob/next/INSTALL.md). 34 | 35 | Start `recoll`, configure it to your liking and let it index. (Recoll full-text indexes a bunch of file 36 | types natively; others need [various helper programs](https://www.lesbonscomptes.com/recoll/pages/features.html#doctypes), 37 | which may or may not be installed.) 38 | 39 | Installation 40 | ------------ 41 | 42 | Just drop `zzzfoo` wherever you like (somewhere in your 43 | `$PATH`, perhaps) and make it executable (`chmod +x zzzfoo`). 44 | 45 | Usage 46 | ----- 47 | 48 | If run without arguments it will launch a Rofi search dialog, search using the 49 | query you enter, present the results, and write the absolute path of your 50 | chosen match to STDOUT. That's of limited use, but there are bunch of options -- 51 | example: 52 | 53 | Open selected match with `xdg-open`: 54 | 55 | zzzfoo -o xdg-open 56 | 57 | _(Do NOT -o something_that_deletes_files; there are certainly bugs. See 58 | [the Arch wiki](https://wiki.archlinux.org/index.php/default_applications#xdg-utils) 59 | for a reminder on how to set default applications for different MIME types.)_ 60 | 61 | Exclude files of type message/rfc822 (emails), open selected file with `xdg-open`: 62 | 63 | zzzfoo -e='-mime:message/rfc822' -o xdg-open 64 | 65 | _(See Recoll's manual section about [the query language](http://www.lesbonscomptes.com/recoll/usermanual/usermanual.html#RCL.SEARCH.LANG). 66 | Note that `$HOME/` is stripped from the **displayed** file path by default, but not from the one actually used when opening.)_ 67 | 68 | By default, Rofi shows 15 lines/rows. zzzfoo makes each line have a height 69 | of 3 characters. If this makes the window height too big, you can pass some options to Rofi; 70 | here window at top right, 50% width, 5 lines/rows: 71 | 72 | zzzfoo -r="-location 3 -width 50 -lines 5" 73 | 74 | Run query directly (and show results in Rofi) without using the search dialog, 75 | light grey color for abstracts: 76 | 77 | zzzfoo --color-abstract '#777' foobar 78 | 79 | zzzfoo --color-abstract '#777' 'quote if multiple search terms' 80 | 81 | Show synthetic abstracts (i.e. constructed by extracting text around search terms; 82 | the indexed abstract, shown by default, is often just the beginning of the file): 83 | 84 | zzzfoo --synthetic-abstract 85 | 86 | _(Note: this is a bit slower.)_ 87 | 88 | Run the script with `-h` to see all options. 89 | 90 | See http://www.lesbonscomptes.com/recoll/usermanual/usermanual.html#RCL.SEARCH.LANG for 91 | information about the query language. 92 | 93 | For theming Rofi, see https://github.com/DaveDavenport/rofi-themes. 94 | 95 | I suggest binding zzzfoo to something convenient. For example, for i3 I have the 96 | following in `~/.i3/config`: 97 | 98 | bindsym $mod+space exec --no-startup-id ~/bin/zzzfoo -e="-mime:message/rfc822" -o xdg-open 99 | 100 | Messy Python-free sed-n-awk alternative 101 | --------------------------------------- 102 | 103 | Just for fun (hmm), or if you really don't want to use Python, here's a 104 | script that simply parses the output of Recoll's text mode and provides 105 | something similar to the Python script. Note that it will break if Recoll 106 | changes its default output format, or perhaps due to certain characters in 107 | file names, or for other reasons. Use the Python version. 108 | 109 | (It's possible to use the fact that Recoll can output base64-encoded fields 110 | which would be much easier to handle, but that's a bit slower. Some of the 111 | weirdness below is required for it to work with both GNU and BSD versions of 112 | tools, and with plain bourne shells.) 113 | 114 | ```sh 115 | #!/bin/sh 116 | 117 | PATH_TO_STRIP="/home/foobar/" 118 | rofi_search=$(rofi -dmenu -p 'Search: ') 119 | 120 | if [ -n "${rofi_search}" ]; then 121 | file_path=$(recoll -t -A -e -n 20 "${rofi_search}" \ 122 | | tail -n +3 \ 123 | | sed 'N;N;N;s/\n/ /g' \ 124 | | sed 's/&/\&/g; s//\>/g; s/"/\"/g' \ 125 | | sed 's/'"'"'/\'/g; s/“/\"/g; s/”/\"/g' \ 126 | | awk 'BEGIN {FS="\t"; OFS=FS} 127 | {{gsub(/^ ABSTRACT |\/ABSTRACT/, "", $6)}} 128 | {print "" substr($3,2,length($3)-2) " " $1 ""; 129 | print "ZZZBAR" $2; print $6 "\n\n" $2 "ZZZFOO"}' \ 130 | | tr -d '\t' \ 131 | | awk '{gsub(/ZZZFOO$/,"\t");}1' \ 132 | | sed "s#^ZZZBAR\[file://${PATH_TO_STRIP}\(.*\)\]#\1#" \ 133 | | awk '{gsub(/^\[file:\/\//,"");}1' \ 134 | | awk '{gsub(/\]\t/,"\t");}1' \ 135 | | sed 's/+/ /g;s/%/\\x/g' \ 136 | | xargs -0 printf "%b" \ 137 | | sed -e ':a' -e 'N' -e '$!ba' -e 's/ \n/ /g' \ 138 | | sed '$ s/.$//' \ 139 | | rofi -dmenu -eh 3 -sep '\t' -markup-rows -p "Filter results: " \ 140 | | tail -n 1 \ 141 | | sed 's/&/\&/g; s/<//g; s/"/"/g; s/'/'"'"'/g' \ 142 | | tr -d '\n') 143 | 144 | if [ -n "${file_path}" ]; then 145 | xdg-open "${file_path}" 146 | exit 0 147 | fi 148 | fi 149 | ``` 150 | 151 | (Note that the third-to-last sed with `'s/ \n/ /g'` contains two actual tabs, 152 | not spaces. Be careful so that your editor doesn't replace these with spaces 153 | when pasting. `\t` would've been more convenient but alas, can't use that 154 | (at least not in the replacement) because POSIX. I think.) 155 | -------------------------------------------------------------------------------- /zzzfoo: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Do a Recoll search using Rofi. Requires Recoll, the Recoll Python module, 5 | # and Rofi. Python 3 only. 6 | # 7 | # Inspired by recollq.py by Jean-Francois Dockes. 8 | # 9 | # Anders Jensen-Urstad 10 | # License: GPLv2 11 | 12 | __version__ = "0.4" 13 | 14 | import sys 15 | import re 16 | from os import getenv 17 | from argparse import ArgumentParser, RawTextHelpFormatter 18 | from html import escape 19 | from base64 import b64encode, b64decode 20 | from subprocess import Popen, PIPE 21 | from recoll import recoll 22 | import shlex 23 | 24 | class matchmethods(object): 25 | def startMatch(self, idx): 26 | return '' 27 | def endMatch(self): 28 | return '' 29 | 30 | def colorize(string, color): 31 | return '%s' % (color, string) 32 | 33 | def to_unicode(string): 34 | if string and not isinstance(string, str): 35 | return str(string, 'utf-8') 36 | else: 37 | return string 38 | 39 | def process_doc(query, doc, match_obj, args): 40 | res = {} 41 | 42 | if doc.title: 43 | res['title'] = escape(doc.title, False) 44 | else: 45 | res['title'] = escape(doc.filename, False) 46 | 47 | absolute_path = b64encode(doc.url.replace('file://', '', 1).encode('utf-8')).decode('utf-8') 48 | 49 | colors = {'abstract': args.color_abstract, 'file_path': args.color_path, 50 | 'title': args.color_title, 'file_info': args.color_file_info} 51 | 52 | res['file_path'] = escape(doc.url, False) 53 | res['file_path'] = res['file_path'].replace('file://', '', 1) 54 | if args.strip_path and res['file_path'].startswith(args.strip_path): 55 | res['file_path'] = res['file_path'][len(args.strip_path) + 1:] 56 | 57 | res['file_info'] = doc.mtype 58 | 59 | res['abstract'] = '' 60 | if args.show_abstract: 61 | if args.synthetic_abstract: 62 | res['abstract'] = escape(query.makedocabstract(doc, methods=match_obj), False).strip().replace('\0', '') 63 | res['abstract'] = res['abstract'].replace('<b>', '') 64 | res['abstract'] = res['abstract'].replace('</b>', '') 65 | else: 66 | res['abstract'] = escape(doc.abstract, False).strip().replace('\0', '') 67 | res['abstract'] = query.highlight(res['abstract'], ishtml=0, methods=match_obj) 68 | 69 | # Try to check if document is contained with another document. Not sure how useful 70 | # this actually is (so disabled)... 71 | #if doc.rcludi.endswith('|'): 72 | # res['warning'] = '' 73 | #else: 74 | # res['warning'] = 'Inside ' 75 | 76 | for field in res: 77 | if colors[field]: 78 | res[field] = colorize(res[field], colors[field]) 79 | 80 | if args.show_abstract: 81 | output = '{title} {file_info}\n{file_path}\n{abstract}' \ 82 | '\n\n{absolute_path}' 83 | else: 84 | output = '{title} {file_info}\n{file_path}\n\n{absolute_path}' 85 | 86 | formatted = output.format(title=res['title'], file_info=res['file_info'], file_path=res['file_path'], 87 | abstract=res['abstract'], absolute_path=absolute_path) 88 | 89 | # We use \t as item separator with Rofi, so strip them from item content 90 | return re.sub(r'\t', '', formatted) + '\t' 91 | 92 | def run_query(recoll_db, args): 93 | query = recoll_db.query() 94 | results = query.execute(args.query_string) 95 | match_obj = matchmethods() 96 | user_num_results = int(args.num_results) 97 | 98 | if results: 99 | if results > user_num_results and user_num_results != 0: 100 | results_docs = query.fetchmany(user_num_results) 101 | else: 102 | results_docs = query.fetchmany(results) 103 | 104 | results_list = [] 105 | for doc in results_docs: 106 | results_list.append(process_doc(query, doc, match_obj, args)) 107 | 108 | return results_list 109 | return False 110 | 111 | def handle_args(): 112 | epilog_str = 'By default this program simply outputs the path of the\n' \ 113 | 'selected match, so you could use a pipe instead of -o .\n' \ 114 | 'Colors should be specified in hex (\'#FF0000\') or by name (\'red\').' 115 | 116 | parser = ArgumentParser(formatter_class=RawTextHelpFormatter, epilog=epilog_str) 117 | parser.add_argument('-c', '--recoll-confdir', default='', 118 | help='Recoll config directory, if not default (overrides $RECOLL_CONFDIR)') 119 | parser.add_argument('-e', '--query-extra', default=None, 120 | help='Additional search arguments to add to Recoll query.\n' \ 121 | 'To avoid issues use a leading space (-e \' -foo\'),\n' \ 122 | 'or do --query-extra="-foo"') 123 | parser.add_argument('-i', '--extra-dbs', default=[], 124 | help='Additional index(es) to search. E.g. -i ~/.recoll-foo.\n' \ 125 | 'If multiple, put inside quotes and use absolute paths:\n' \ 126 | '-i \'/home/foo/.recoll-one/xapiandb /home/foo/.recoll-two/xapiandb\'') 127 | parser.add_argument('--no-abstract', dest='show_abstract', action='store_false', 128 | help='Don\'t show abstracts') 129 | parser.add_argument('--synthetic-abstract', dest='synthetic_abstract', action='store_true', 130 | help='Tells Recoll to build an abstract by extracting text around search terms,\n' \ 131 | 'rather than the one stored in the index. A bit slower.') 132 | parser.add_argument('-n', '--num-results', default=20, 133 | help='Number of results to show (default 20; 0 for no limit)') 134 | parser.add_argument('-o', '--open-with', default=None, 135 | help='Open match with specified program., e.g. -o xdg-open, -o \'subl -n\'') 136 | parser.add_argument('query_string', nargs='?', default=None, 137 | help='Search query. Quote multiple terms. If omitted, search dialog will be shown.') 138 | parser.add_argument('-r', '--rofi-options', default=None, 139 | help='Extra arguments to Rofi. To avoid issues use a leading space, e.g.:\n' \ 140 | '-r \' -width 60 -location 1\'\n' \ 141 | 'or do --rofi-options=\'-width 60 -location 1\'') 142 | parser.add_argument('-p', '--strip-path', default=getenv('HOME', None), 143 | help='Path to strip from *displayed* file path. Default: $HOME.\n' \ 144 | 'Don\'t include trailing slash. Set to \'\' to disable.') 145 | parser.add_argument('-x', '--xclip-copy', dest='xclip_copy', action='store_true', 146 | help='Copy path of selected match to X primary selection (xclip required)') 147 | parser.add_argument('-V', '--version', action='version', help='Show program version.', 148 | version='%(prog)s {version}'.format(version=__version__)) 149 | parser.add_argument('--prompt', default='Search', help='Rofi prompt') 150 | parser.add_argument('--search-mesg', default=None, help='Message for the search prompt') 151 | parser.add_argument('--result-mesg', default=None, help='Message for the result prompt') 152 | 153 | colors = ['--color-abstract', '--color-file-info', '--color-path', '--color-title'] 154 | for color in colors: 155 | parser.add_argument(color, default=None) 156 | 157 | parser.set_defaults(show_abstract=True, xclip_copy=False, synthetic_abstract=False) 158 | return parser.parse_args() 159 | 160 | def main(argv): 161 | args = handle_args() 162 | 163 | # If query wasn't specified on command line, open a Rofi dialog to ask for it 164 | if not args.query_string: 165 | rofi_search_cmd = ['rofi', '-dmenu', '-p', args.prompt] 166 | if args.search_mesg is not None: 167 | rofi_search_cmd += ['-mesg', args.search_mesg] 168 | 169 | if args.rofi_options: 170 | rofi_search_cmd += shlex.split(args.rofi_options) 171 | 172 | search_dialog = Popen(rofi_search_cmd, stdout=PIPE, stderr=PIPE) 173 | args.query_string = to_unicode(search_dialog.communicate()[0].strip()) 174 | 175 | if search_dialog.returncode != 0: 176 | sys.exit(1) 177 | 178 | if args.query_extra and args.query_string: 179 | args.query_string += ' ' + args.query_extra 180 | 181 | if args.extra_dbs: 182 | args.extra_dbs = args.extra_dbs.split() 183 | 184 | recoll_db = recoll.connect(confdir=args.recoll_confdir, extra_dbs=args.extra_dbs) 185 | recoll_db.setAbstractParams(maxchars=100, contextwords=10) 186 | 187 | if args.query_string: 188 | results_list = run_query(recoll_db, args) 189 | if results_list: 190 | results_formatted = ''.join(results_list) 191 | else: 192 | results_formatted = 'No results.' 193 | else: 194 | sys.exit(0) 195 | 196 | rofi_element_height = '3' 197 | if not args.show_abstract: 198 | rofi_element_height = '2' 199 | 200 | rofi_results_cmd = ['rofi', '-dmenu', '-markup-rows', '-eh', rofi_element_height, 201 | '-sep', '\t', '-p', 'Filter results'] 202 | if args.result_mesg is not None: 203 | rofi_results_cmd += ['-mesg', args.result_mesg] 204 | if args.rofi_options: 205 | rofi_results_cmd += shlex.split(args.rofi_options) 206 | 207 | # Pipe formatted results to Rofi 208 | rofi = Popen(rofi_results_cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE) 209 | selected_match = rofi.communicate(input=results_formatted.encode('utf-8'))[0].decode('utf-8') 210 | 211 | # If a match was selected, decode its file path and do something with it 212 | if selected_match and results_list: 213 | file_path = b64decode(selected_match.split()[-1]).decode('utf-8') 214 | 215 | if args.xclip_copy: 216 | xclip = Popen(['xclip', '-selection', 'primary', '-f'], stdin=PIPE) 217 | xclip.communicate(input=file_path) 218 | 219 | if args.open_with: 220 | open_cmd = args.open_with.split() 221 | open_cmd.append(file_path) 222 | Popen(open_cmd) 223 | sys.exit(0) 224 | 225 | print(file_path) 226 | 227 | sys.exit(0) 228 | 229 | if __name__ == '__main__': 230 | main(sys.argv) 231 | --------------------------------------------------------------------------------