├── .gitignore
├── LICENSE
├── README.rst
├── TODO.rst
└── bm.py
/.gitignore:
--------------------------------------------------------------------------------
1 | bm.egg-info
2 | build
3 | dist
4 | test
5 | src
6 | *.tar.gz
7 | __pycache__/
8 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
1 | Description
2 | ===========
3 |
4 | Simple command line bookmark and/or tagging utility.
5 |
6 | One way to see this program is to consider it a simple hashmap utility for
7 | bash that associates a set of strings (the tags) to another one (the url).
8 | Feel free to find other ways to use this program!
9 |
10 | It is based on a sqlite database but supports input/output in json or msgpack
11 | and can even serve a web page for better integration with the browser.
12 |
13 | This script is written using python3.
14 |
15 | THIS VERSION IS IN DEVELOPMENT.
16 |
17 |
18 | Documentation
19 | =============
20 | ::
21 |
22 | Simple command line browser independant bookmark utility
23 |
24 | Usage: bm add [-d DB] URL TAG...
25 | bm list [-d DB] [-f FMT] [-v] [TAG]...
26 | bm tags [-d DB] [-f FMT] [URL]...
27 | bm remove [-d DB] URL TAG...
28 | bm delete [-d DB] URL...
29 | bm import [-d DB] [-f FMT] FILE...
30 |
31 | Commands:
32 | add Tag a URL
33 | list List URLs matching some tags
34 | If TAG is empty, outputs all urls
35 | tags List tags associated to URLs
36 | If URLs is empty, outputs all tags with statistics
37 | remove Remove TAGs from URLs
38 | delete Remove URLs from the database
39 | import Import URLs into the database
40 |
41 | Arguments:
42 | URL An URL or path; if '-', looks for a list of URLs on stdin
43 | TAG A tag
44 | FILE Path to a file for import
45 | GROUP A set of tags; Using a group sets all the tags within that group
46 |
47 | Options:
48 | -h, --help Print this help and exit
49 | --version Print current version number and exit
50 | -d, --database DB Path to the database to use
51 | -f, --format FMT Input/Output format: text, json, msgpack, web
52 | -v, --verbose Display tags alongside the URL while listing
53 |
54 | Example
55 | =======
56 |
57 | ::
58 |
59 | $ bm add "http://duckduckgo.com" bad search engine
60 |
61 | $ bm add "http://google.com" bad search engine
62 |
63 | $ bm add "http://python.org" python official
64 |
65 | $ bm list search engine
66 | http://duckduckgo.com
67 | http://google.com
68 |
69 | $ bm remove "http://duckduckgo.com" bad
70 |
71 | $ bm add "http://duckduckgo.com" cool
72 |
73 | $ bm tags "http://duckduckgo.com"
74 | cool
75 | engine
76 | search
77 |
78 | $ bm list search engine
79 | http://duckduckgo.com
80 | http://google.com
81 |
82 | $ bm list bad search engine
83 | http://google.com
84 |
85 | $ bm list
86 | http://duckduckgo.com
87 | http://google.com
88 | http://python.org
89 |
90 | $ bm tags
91 | cool
92 | engine
93 | search
94 | bad
95 | python
96 | official
97 |
98 | # Add all tags from a url to another
99 | $ bm tags http://duckduckgo.com | xargs bm add http://google.com
100 |
101 | # Add tags to a set of urls
102 | $ bm list search engine | xargs -I{} bm add {} website find data
103 |
104 |
105 | And you, how do you use it?
106 | ===========================
107 |
108 | As many cli tools, bm is designed the Unix way: with composability in mind.
109 | This is why its output is mainly plain text, one entry per line with simple
110 | separators.
111 |
112 | I use urxvt and the urxvt-perls that allow fast link openning from the
113 | terminal.
114 |
115 | My main browser is qutebrowser but I had bm linked with dwb or firefox
116 | before. To do that I keep in my configuration two keybindings that execute
117 | external commands:
118 |
119 | ::
120 |
121 | set-cmd-text -s :spawn -- bm add '{url}'
122 | b
123 | set-cmd-text -s :spawn -- bm list -v -f web
124 | B
125 |
126 | That way, when on a page, I press b to bookmark the current url and just type
127 | the tags on the browser prompt. B is for searching, note how it uses the html
128 | display with -f web to open the results in a new tab.
129 |
130 | For synchronisation I relie on a script that scp's the bookmark file between
131 | my computers and then does a local file import.
132 |
133 | These are only some personal examples, I hope you'll find yours!
134 |
135 |
136 | To be implemented
137 | =================
138 |
139 | bm will support the use of sets of tags. Anything starting with the symbol `+`
140 | will be understood as a tag set. If used instead of a URL it will add tags
141 | to the set. If used instead of a tag it will act as if all tags in the set
142 | were listed. This will not involve a change of database since it already has
143 | the required tables (I'm just a slow coder).
144 |
145 | Dependencies
146 | ============
147 |
148 | Required
149 | --------
150 |
151 | docopt https://github.com/docopt/docopt or "pip install docopt"
152 |
153 | Optional
154 | --------
155 |
156 | msgpack http://msgpack.org/ or "pip install msgpack-python"
157 |
158 | License
159 | =======
160 |
161 | This program is under the GPLv3 License.
162 |
163 | You should have received a copy of the GNU General Public License
164 | along with this program. If not, see http://www.gnu.org/licenses/.
165 |
166 | Contact
167 | =======
168 |
169 | ::
170 |
171 | Main developper: Cédric Picard
172 | Email: cpicard@purrfect.fr
173 |
--------------------------------------------------------------------------------
/TODO.rst:
--------------------------------------------------------------------------------
1 | - Splitting and refactoring
2 | - Export timestamps for propagation
3 | - Tag sets
4 | - Support adding from list of urls (cat urls | bm add - tag1 tag2)
5 |
--------------------------------------------------------------------------------
/bm.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | """
4 | Simple command line browser independant bookmark utility
5 |
6 | Usage: bm add [-d DB] URL TAG...
7 | bm list [-d DB] [-f FMT] [-v] [TAG]...
8 | bm tags [-d DB] [-f FMT] [URL]...
9 | bm remove [-d DB] URL TAG...
10 | bm delete [-d DB] URL...
11 | bm import [-d DB] [-f FMT] FILE...
12 |
13 | Commands:
14 | add Tag a URL
15 | list List URLs matching some tags
16 | If TAG is empty, outputs all urls
17 | tags List tags associated to URLs
18 | If URLs is empty, outputs all tags with statistics
19 | remove Remove TAGs from URLs
20 | delete Remove URLs from the database
21 | import Import URLs into the database
22 |
23 | Arguments:
24 | URL An URL or path; if '-', looks for a list of URLs on stdin
25 | TAG A tag
26 | FILE Path to a file for import
27 | GROUP A set of tags; Using a group sets all the tags within that group
28 |
29 | Options:
30 | -h, --help Print this help and exit
31 | --version Print current version number and exit
32 | -d, --database DB Path to the database to use
33 | -f, --format FMT Input/Output format: text, json, msgpack, web
34 | -v, --verbose Display tags alongside the URL while listing
35 | """
36 | VERSION = "2.0.2"
37 |
38 | import os
39 | import sys
40 | from docopt import docopt
41 |
42 | # Debug log function, by defaults prints nothing.
43 | global debug
44 | debug = lambda *x,**kx: None
45 |
46 | class Database:
47 | def __init__(self, path):
48 | import sqlite3
49 |
50 | debug("Initializing database from file " + path)
51 |
52 | self.path = path
53 | if not os.path.exists(self.path):
54 | try:
55 | os.mkdir(os.path.split(self.path)[0])
56 | except FileExistsError:
57 | pass
58 |
59 | self.conn = sqlite3.connect(path)
60 | self._init_db()
61 |
62 |
63 | def _init_db(self):
64 | c = self.conn.cursor()
65 |
66 | c.execute("""
67 | CREATE TABLE IF NOT EXISTS urls (
68 | id INTEGER PRIMARY KEY AUTOINCREMENT,
69 | url STRING NOT NULL,
70 | enabled_t TIMESTAMP WITH TIME ZONE,
71 | disabled_t TIMESTAMP WITH TIME ZONE,
72 | UNIQUE(url)
73 | );
74 | """)
75 |
76 | c.execute("""
77 | CREATE TABLE IF NOT EXISTS tags (
78 | id INTEGER PRIMARY KEY AUTOINCREMENT,
79 | name STRING NOT NULL, UNIQUE(name)
80 | );
81 | """)
82 |
83 | c.execute("""
84 | CREATE TABLE IF NOT EXISTS x_tag_url (
85 | id_tag INTEGER NOT NULL,
86 | id_url INTEGER NOT NULL,
87 | enabled_t TIMESTAMP WITH TIME ZONE,
88 | disabled_t TIMESTAMP WITH TIME ZONE,
89 | PRIMARY KEY (id_tag, id_url)
90 | );
91 | """)
92 |
93 | c.execute("""
94 | CREATE TABLE IF NOT EXISTS tagsets (
95 | id INTEGER PRIMARY KEY AUTOINCREMENT,
96 | name STRING NOT NULL,
97 | enabled_t TIMESTAMP WITH TIME ZONE,
98 | disabled_t TIMESTAMP WITH TIME ZONE,
99 | UNIQUE(name)
100 | );
101 | """)
102 |
103 | c.execute("""
104 | CREATE TABLE IF NOT EXISTS x_tag_set (
105 | id_tag INTEGER NOT NULL,
106 | id_set INTEGER NOT NULL,
107 | enabled_t TIMESTAMP WITH TIME ZONE,
108 | disabled_t TIMESTAMP WITH TIME ZONE,
109 | PRIMARY KEY (id_tag, id_set)
110 | );
111 | """)
112 |
113 | c.execute("""
114 | CREATE VIEW IF NOT EXISTS enabled_urls (id, url) AS
115 | SELECT id,url FROM urls
116 | WHERE disabled_t is NULL
117 | OR enabled_t > disabled_t;
118 | """)
119 |
120 | c.execute("""
121 | CREATE VIEW IF NOT EXISTS disabled_urls (id, url) AS
122 | SELECT id,url FROM urls
123 | WHERE disabled_t > enabled_t;
124 | """)
125 |
126 | c.execute("""
127 | CREATE VIEW IF NOT EXISTS enabled_x_tag_url (id_tag, id_url) AS
128 | SELECT id_tag,id_url FROM x_tag_url
129 | WHERE disabled_t is NULL
130 | OR enabled_t > disabled_t;
131 | """)
132 |
133 | c.execute("""
134 | CREATE VIEW IF NOT EXISTS disabled_x_tag_url (id_tag, id_url) AS
135 | SELECT id_tag,id_url FROM x_tag_url
136 | WHERE disabled_t > enabled_t;
137 | """)
138 |
139 | c.execute("""
140 | CREATE VIEW IF NOT EXISTS enabled_tagsets (id, name) AS
141 | SELECT id,name FROM tagsets
142 | WHERE disabled_t is NULL
143 | OR enabled_t > disabled_t;
144 | """)
145 |
146 | c.execute("""
147 | CREATE VIEW IF NOT EXISTS disabled_tagsets (id, name) AS
148 | SELECT id,name FROM tagsets
149 | WHERE disabled_t > enabled_t;
150 | """)
151 |
152 | c.execute("""
153 | CREATE VIEW IF NOT EXISTS enabled_x_tag_set (id_tag, id_set) AS
154 | SELECT id_tag,id_set FROM x_tag_set
155 | WHERE disabled_t is NULL
156 | OR enabled_t > disabled_t;
157 | """)
158 |
159 | c.execute("""
160 | CREATE VIEW IF NOT EXISTS disabled_x_tag_set (id_tag, id_set) AS
161 | SELECT id_tag,id_set FROM x_tag_set
162 | WHERE disabled_t > enabled_t;
163 | """)
164 |
165 | c.execute("""
166 | CREATE VIEW IF NOT EXISTS v_tag_url (url, tag) AS
167 | SELECT url,name FROM enabled_urls,tags,enabled_x_tag_url
168 | WHERE enabled_urls.id=id_url
169 | AND tags.id=id_tag;
170 | """)
171 |
172 | c.execute("""
173 | CREATE VIEW IF NOT EXISTS v_tag_set (tagsets, tag) AS
174 | SELECT tagsets.name,tags.name FROM enabled_tagsets,tags,enabled_x_tag_set
175 | WHERE enabled_tagsets.id=id_set
176 | AND tags.id=id_tag;
177 | """)
178 |
179 |
180 | self.conn.commit()
181 |
182 |
183 | def add(self, url, tags, *, commit=True):
184 | debug("Adding {} to {}".format(tags, url))
185 |
186 | c = self.conn.cursor()
187 |
188 | c.execute("INSERT OR IGNORE INTO urls (url) VALUES (?)", [url])
189 |
190 | c.execute("""
191 | UPDATE urls SET enabled_t=CURRENT_TIMESTAMP WHERE url=?;
192 | """, [url])
193 |
194 | # Remove duplicates
195 | tag = set(tags)
196 |
197 | c.executemany("""
198 | INSERT OR IGNORE INTO tags (name) VALUES (?)
199 | """, ([tag] for tag in tags))
200 |
201 | c.executemany("""
202 | INSERT OR IGNORE INTO x_tag_url
203 | (id_url, id_tag)
204 | VALUES (
205 | (SELECT id FROM urls WHERE url=?),
206 | (SELECT id FROM tags WHERE name=?)
207 | )
208 | """, ((url, tag) for tag in tags))
209 |
210 | c.executemany("""
211 | UPDATE x_tag_url
212 | SET enabled_t = CURRENT_TIMESTAMP
213 | WHERE id_url = (SELECT id FROM urls WHERE url=?)
214 | AND id_tag = (SELECT id FROM tags WHERE name=?);
215 | """, ((url, tag) for tag in tags))
216 |
217 | if commit:
218 | self.conn.commit()
219 |
220 |
221 | def list(self, tags, list_tags):
222 | debug("List urls with tags {}" .format(tags))
223 |
224 | c = self.conn.cursor()
225 |
226 | if list_tags:
227 | stmt = "SELECT url,group_concat(tag, ' ') FROM v_tag_url "
228 |
229 | if tags:
230 | stmt += "WHERE url in ("
231 | stmt += " INTERSECT ".join(
232 | "SELECT url FROM v_tag_url WHERE tag=?"
233 | for _ in tags)
234 | stmt += ")"
235 |
236 | stmt += " GROUP BY url ORDER BY url;"
237 |
238 | debug(stmt)
239 | c.execute(stmt, tags)
240 | return { x[0]:x[1].split(' ') for x in c.fetchall() }
241 |
242 |
243 | if tags:
244 | stmt = " INTERSECT ".join("SELECT url FROM v_tag_url WHERE tag=?"
245 | for _ in tags)
246 | debug(stmt)
247 | c.execute(stmt, tags)
248 |
249 | else:
250 | c.execute("SELECT url FROM enabled_urls ORDER BY url")
251 |
252 | return { u[0]: None for u in c.fetchall() }
253 |
254 |
255 | def remove(self, url, tags):
256 | debug("Removing {} from {}".format(tags, url))
257 |
258 | c = self.conn.cursor()
259 |
260 | c.executemany("""
261 | UPDATE x_tag_url
262 | SET disabled_t = CURRENT_TIMESTAMP
263 | WHERE id_url = (SELECT id FROM urls WHERE url=?)
264 | AND id_tag = (SELECT id FROM tags WHERE name=?);
265 | """, ((url, tag) for tag in tags))
266 |
267 | self.conn.commit()
268 |
269 | debug("Cleaning unaffilliated tags")
270 |
271 | c.execute("""
272 | DELETE FROM tags
273 | WHERE NOT EXISTS (
274 | SELECT id_url FROM x_tag_url
275 | WHERE id_tag=tags.id
276 | );
277 | """);
278 |
279 | debug("Cleaning unaffilliated urls")
280 |
281 | c.execute("""
282 | UPDATE urls
283 | SET disabled_t = CURRENT_TIMESTAMP
284 | WHERE NOT EXISTS (
285 | SELECT id_tag FROM x_tag_url
286 | WHERE id_url=urls.id
287 | );
288 | """);
289 |
290 | self.conn.commit()
291 |
292 |
293 | def delete(self, urls):
294 | debug("Deleting {}".format(urls))
295 |
296 | c = self.conn.cursor()
297 |
298 | c.executemany("""
299 | UPDATE urls
300 | SET disabled_t = CURRENT_TIMESTAMP
301 | WHERE url=?;
302 | """, [urls])
303 |
304 | debug("Cleaning unaffilliated XREF")
305 |
306 | c.execute("""
307 | UPDATE x_tag_url
308 | SET disabled_t = CURRENT_TIMESTAMP
309 | WHERE NOT EXISTS (
310 | SELECT id FROM urls
311 | WHERE id_url=urls.id
312 | );
313 | """)
314 |
315 | debug("Cleaning unaffilliated tags")
316 |
317 | c.execute("""
318 | DELETE FROM tags
319 | WHERE NOT EXISTS (
320 | SELECT id_url FROM x_tag_url
321 | WHERE id_tag=tags.id
322 | );
323 | """);
324 |
325 | self.conn.commit()
326 |
327 | def import_file(self, data, fmt):
328 | debug("Importing data in {}".format(fmt))
329 |
330 | if fmt == "html":
331 | print("Error: html is not supported for import")
332 | return
333 |
334 | if fmt == "msgpack":
335 | import msgpack
336 | content = msgpack.loads(data, raw=False)
337 |
338 | if fmt == "json":
339 | import json
340 | content = json.loads(data.decode("utf8"))
341 |
342 | if fmt == "text":
343 | data = data.decode("utf8")
344 | content = {
345 | l.split(' ')[0]: l.split(' ')[1:]
346 | for x in data.decode("utf8").splitlines()
347 | }
348 |
349 | # Only want to commit once after having added all URLs for efficiency
350 | for url,tags in content.items():
351 | self.add(url, tags, commit=False)
352 | self.conn.commit();
353 |
354 | def tags(self, urls):
355 | c = self.conn.cursor()
356 |
357 | if not urls:
358 | debug("Listing all tags")
359 |
360 | c.execute("""
361 | SELECT name,count(id_url) FROM tags,enabled_x_tag_url
362 | WHERE id_tag=id
363 | GROUP BY name
364 | ORDER BY 2;
365 | """)
366 |
367 | return { t[0]: t[1] for t in c.fetchall() }
368 |
369 | debug("Listing tags from {}".format(urls))
370 | stmt = " UNION ".join("SELECT tag FROM v_tag_url WHERE url=?"
371 | for _ in urls)
372 | stmt += " ORDER BY tag"
373 | debug(stmt)
374 | c.execute(stmt, urls)
375 |
376 | return { t[0]: None for t in c.fetchall() }
377 |
378 |
379 | def close(self):
380 | debug("Closing database")
381 | self.conn.close()
382 |
383 |
384 | def format_urls(urls, fmt, search=[]):
385 | debug("Outputing {} urls in {}")
386 |
387 | verbose = not None in urls.values()
388 |
389 | if fmt == "msgpack":
390 | import msgpack
391 | if not verbose:
392 | return msgpack.dumps(list(urls.keys()))
393 | else:
394 | return msgpack.dumps(
395 | { url:list(tags) for url,tags in urls.items() }
396 | )
397 |
398 | if fmt == "text":
399 | if not verbose:
400 | result = '\n'.join(urls)
401 | else:
402 | result = '\n'.join("{} {}".format(url, ' '.join(map(str,tags)))
403 | for url,tags in urls.items())
404 |
405 | elif fmt == "json":
406 | import json
407 | if not verbose:
408 | result = json.dumps(list(urls.keys()), indent=4)
409 | else:
410 | result = json.dumps({ url:list(tags) for url,tags in urls.items() },
411 | indent=4)
412 |
413 | elif fmt == "web":
414 | if not search:
415 | result = html_generator(["All urls"], urls)
416 | else:
417 | result = html_generator(search, urls)
418 |
419 | return (result + "\n").encode("utf-8")
420 |
421 |
422 | def format_tags(tags, fmt):
423 | verbose = None not in tags.values()
424 |
425 | if fmt == "msgpack":
426 | import msgpack
427 | if not verbose:
428 | return msgpack.dumps(tags.keys())
429 | else:
430 | return msgpack.dumps(
431 | { tag:count for tag,count in tags.items() }
432 | )
433 |
434 | if fmt == "text":
435 | if not verbose:
436 | result = '\n'.join(map(str,tags))
437 | else:
438 | result = '\n'.join("{} {}".format(tag, count)
439 | for tag,count in tags.items())
440 |
441 | elif fmt == "json":
442 | import json
443 | if not verbose:
444 | result = json.dumps(tags.keys(), indent=4)
445 | else:
446 | result = json.dumps({ tag:count for tag,count in tags.items() },
447 | indent=4)
448 |
449 | elif fmt == "web":
450 | print("Error: web output not supported for tag listing")
451 |
452 | return (result + "\n").encode("utf-8")
453 |
454 |
455 | def output(data, fmt):
456 | if fmt != "web":
457 | sys.stdout.buffer.write(data)
458 | return
459 |
460 | import webbrowser
461 |
462 | temp_dir = "/tmp/bm-{}/".format(os.getuid())
463 |
464 | try:
465 | os.mkdir(temp_dir)
466 | except FileExistsError:
467 | if os.stat(temp_dir).st_uid != os.getuid():
468 | print("Error: wrong directory permissions")
469 | return
470 | path = temp_dir + "bm.html"
471 | with open(path, "wb") as f:
472 | f.write(data)
473 | webbrowser.open(path)
474 |
475 |
476 | def html_generator(search, sites):
477 | template = """
478 |
479 |
480 |
481 |
482 | bookmark
483 |
484 |
485 |
486 | {tags}
487 |
488 |
489 | {sites}
490 |
491 |
492 |
493 | """
494 |
495 | li_html = '{u}{t}
'
496 |
497 | li_items = []
498 | for url,tags in sites.items():
499 | if tags is None:
500 | tags = []
501 | li_items.append(li_html.format(u=url, t=','.join(map(str,tags))))
502 |
503 | template = template.format(tags=', '.join(search),
504 | sites=('\n'+' '*10).join(li_items))
505 | debug(template)
506 | return template
507 |
508 | def main():
509 | supported_formats = ("text", "json", "msgpack", "web")
510 |
511 | args = docopt(__doc__, version=VERSION)
512 |
513 | if args["--format"] is None:
514 | args["--format"] = "text"
515 |
516 | elif args["--format"] not in supported_formats:
517 | print("Error: --format must be one of ", supported_formats)
518 | return 1
519 |
520 | # To enable debug output, set de DEBUG environment variable
521 | if os.environ.get("DEBUG"):
522 | global debug
523 | debug = lambda *x,**kx: print("[debug]", *x, file=sys.stderr, **kx)
524 |
525 |
526 | db_path = args.get("--database")
527 | if db_path is None:
528 | db_path = os.path.expanduser("~/.config/bm/bookmarks.sqlite")
529 |
530 | db = Database(db_path)
531 |
532 | if args["add"]:
533 | db.add(args["URL"][0], args["TAG"])
534 |
535 | elif args["list"]:
536 | output(format_urls(db.list(args["TAG"],
537 | args["--verbose"]),
538 | args["--format"],
539 | search=args["TAG"]),
540 | args["--format"])
541 |
542 | elif args["remove"]:
543 | db.remove(args["URL"][0], args["TAG"])
544 |
545 | elif args["delete"]:
546 | db.delete(args["URL"])
547 |
548 | elif args["import"]:
549 | for path in (os.path.expanduser(p) for p in args["FILE"]):
550 | if path == "-":
551 | db.import_file(sys.stdin.buffer.read(), args["--format"])
552 | else:
553 | with open(path, "rb") as f:
554 | db.import_file(f.read(), args["--format"])
555 |
556 | elif args["tags"]:
557 | output(format_tags(db.tags(args["URL"]),
558 | args["--format"]),
559 | args["--format"])
560 |
561 | db.close()
562 |
563 | if __name__ == "__main__":
564 | try:
565 | main()
566 | except BrokenPipeError:
567 | pass
568 |
--------------------------------------------------------------------------------