├── .gitignore
├── LICENSE
├── Makefile
├── README.org
├── background.js
├── emacs.svg
├── manifest.json
├── options.css
├── options.html
├── options.js
└── settings.js
/.gitignore:
--------------------------------------------------------------------------------
1 | /build/
2 |
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | sources := $(wildcard *.svg *.png *.js *.css *.json *.html)
2 |
3 | export WEB_EXT_IGNORE_FILES := $(filter-out $(sources),$(wildcard *))
4 | export WEB_EXT_ARTIFACTS_DIR := build
5 |
6 | build: build/addon.xpi
7 |
8 | build/addon.xpi: $(sources)
9 | mkdir -p build
10 | zip $@ $^
11 |
12 | build-webext: $(sources)
13 | web-ext build --ignore-files $(WEB_EXT_IGNORE_FILES)
14 |
15 | sign-webext: $(sources)
16 | web-ext sign --channel=unlisted --ignore-files $(WEB_EXT_IGNORE_FILES)
17 |
18 | .PHONY: build build-webext sign-webext
19 |
--------------------------------------------------------------------------------
/README.org:
--------------------------------------------------------------------------------
1 | #+TITLE:Org Capture (WebExt)
2 |
3 | This is a web-extension for capturing links, quotes, media, pages, etc. with [[https://orgmode.org/worg/org-contrib/org-protocol.html][org-protocol]].
4 |
5 | * Features
6 |
7 | 1. [[https://support.mozilla.org/en-US/kb/manage-extension-shortcuts-firefox][Hotkeys]]. One for storing links, one for capturing the page (or selected text, if the selection is active).
8 | 2. Context menu items for capturing:
9 | - A link to the current page, along with a description pulled from the page's metadata.
10 | - Selected text. Optionally, selections can be captured as HTML. You'll want to use this with something like [[https://github.com/alphapapa/org-protocol-capture-html][org-protocol-capture-html]] to translate the HTML to org mode.
11 | - Media (images, video, etc.). Media can be (optionally) downloaded (through your browser's download manager) before capturing.
12 | 3. A browser action button to perform some default action on click (can either store a link to the current page, or initiate a capture).
13 | 4. Optionally, capturing a selection will capture the HTML itself. You'll want to use this with something like [[https://github.com/alphapapa/org-protocol-capture-html][org-protocol-capture-html]] to translate the HTML to org mode.
14 |
15 | * Contributing & Bug Reports
16 |
17 | This is a /forks welcome/ project. I'm open to feedback and fixes, but I built it because I needed it and don't intend on putting any real effort/time into it. This means:
18 |
19 | - Forks are _VERY MUCH_ welcome, even encouraged. I don't want to maintain this addon, I just built it because I didn't like the existing ones.
20 | - If a patch/issue would require any amount of work/maintenance on my part to land, I'll likely just close it. Please don't take this as commentary on your code and feel free to fork.
21 | - Do file bug reports, but please keep your expecations low.
22 | - You _can_ file feature requests; I'm always interested in new ideas. But don't disappointed if I close them without much discussion beyond a quick "no thanks"/"not interested".
23 |
24 | * Supported Browsers
25 |
26 | At the moment, only the latest version of Firefox is supported. I'm happy to accept patches for other browsers, but I likely won't do much testing.
27 |
28 | * Installing
29 |
30 | Either build it locally or install the latest [[https://github.com/Stebalien/org-capture-extension/releases/][release]]. This addon isn't listed on the Mozilla store and doesn't auto-update. For now, you'll have to install/update manually.
31 |
32 | * Building
33 |
34 | To build, run ~make build~. You'll need the ~zip~ command.
35 |
36 | Before installing, you'll need to either sign the extension, install a version of Firefox that doesn't mandate addon signature validation, or [[https://github.com/Stebalien/firefox-tweak][hack your Firefox install]]. Personally, I'd recommend the second option ([[https://librewolf.net/][LibreWolf]] works great!) then disable ~xpinstall.signatures.required~ in [[about:config]].
37 |
38 | * Signing & Distribution
39 |
40 | For addon distribution, use ~make build-webext~ and ~make sign-webext~. However, these require API keys and we're at the mercy of our Mozilla overlords on when addons actually get signed.
41 |
42 | * History
43 |
44 | Heavily inspired by both [[https://github.com/sprig/org-capture-extension][Org Capture Extension]] and [[https://github.com/vifon/org-protocol-for-firefox][Org Protocol for Firefox]]. However, the former [[https://github.com/sprig/org-capture-extension/issues/80][required permission]] for every new page captured and the latter wasn't very customizable and required manual clicks to complete a capture.
45 |
--------------------------------------------------------------------------------
/background.js:
--------------------------------------------------------------------------------
1 | const icons = {
2 | "16": "emacs.svg",
3 | "32": "emacs.svg"
4 | };
5 |
6 |
7 |
8 | async function getDescription(tab) {
9 | const [{ result, error }] = await browser.scripting.executeScript({
10 | target: {
11 | tabId: tab.id,
12 | },
13 | func: () => {
14 | const descriptionQuery = 'meta[name="description"], meta[property="og:description"], meta[name="twitter:description"]';
15 | const description = document.head.querySelector(descriptionQuery)?.getAttribute('content');
16 | if (!description) {
17 | return null;
18 | }
19 | const container = document.createElement("div");
20 | container.innerHTML = description;
21 | const text = container.innerText.trim();
22 | return text.length > 0 ? text : null;
23 | }
24 | });
25 | if (error) {
26 | throw error;
27 | } else {
28 | return result;
29 | }
30 | }
31 |
32 | async function getSelection(tab, html) {
33 | const [{ result, error }] = await browser.scripting.executeScript({
34 | target: {
35 | tabId: tab.id,
36 | },
37 | args: [html],
38 | func: (html) => {
39 | const selection = document.getSelection();
40 | if (selection?.isCollapsed) {
41 | return null;
42 | }
43 | if (!html) {
44 | return selection.toString();
45 | }
46 |
47 | // The following has been adapted (and heavily modified) from
48 | // https://github.com/alphapapa/org-protocol-capture-html
49 |
50 | // Copy out the selection.
51 | const container = document.createElement("div");
52 | for (let i = 0, len = selection.rangeCount; i < len; ++i) {
53 | container.appendChild(selection.getRangeAt(i).cloneContents());
54 | }
55 |
56 | // Remove invisible elements.
57 | for (const element of container.getElementsByTagName('*')) {
58 | if (window.getComputedStyle(element).display === 'none') {
59 | element.remove();
60 | }
61 | }
62 |
63 | // Make links absolute.
64 | var elementTypes = [
65 | ["a", "href"],
66 | ["source", "src"],
67 | ["video", "src"],
68 | ["audio", "src"],
69 | ["picture", "src"],
70 | ["img", "src"],
71 | ];
72 | for (const [tag, attr] of elementTypes) {
73 | for (const element of container.getElementsByTagName(tag)) {
74 | element.setAttribute(
75 | attr,
76 | new URL(element.getAttribute(attr), document.baseURI),
77 | );
78 | }
79 | }
80 | return container.innerHTML;
81 | }
82 | });
83 | if (error) {
84 | throw error;
85 | } else {
86 | return result;
87 | }
88 | }
89 |
90 | async function capture(which, url, title, selection) {
91 | const template = await getSetting(`${which}CaptureTemplate`);
92 | const protocol = await getSetting(`${which}CaptureProtocol`);
93 | let data = { url, title, template };
94 | if (selection) {
95 | data.body = selection;
96 | }
97 | await browser.tabs.update({
98 | url: `org-protocol://${protocol}?${new URLSearchParams(data)}`,
99 | });
100 | }
101 |
102 | async function storeLink(url, title) {
103 | const data = { url, title };
104 | await browser.tabs.update({
105 | url: `org-protocol://store-link?${new URLSearchParams(data)}`,
106 | });
107 | }
108 |
109 | async function autoCapture(tab) {
110 | const html = await getSetting("captureHtml");
111 | let body = await getSelection(tab, html);
112 | let which = "selection";
113 | if (!body) {
114 | which = "link";
115 | body = await getDescription(tab);
116 | }
117 | return capture(which, tab.url, tab.title, body);
118 | }
119 |
120 | browser.browserAction.onClicked.addListener(async (tab) => {
121 | const defaultAction = await getSetting("defaultAction");
122 | switch (defaultAction) {
123 | case "store":
124 | return storeLink(tab.url, tab.title);
125 | case "capture":
126 | return autoCapture(tab);
127 | default:
128 | throw new Error(`unknown default action ${defaultAction}`);
129 | }
130 | });
131 |
132 | browser.menus.create({
133 | id: "capture-selection",
134 | title: "Capture Selection",
135 | contexts: ["selection"],
136 | icons: icons,
137 | });
138 |
139 | browser.menus.create({
140 | id: "capture-media",
141 | title: "Capture Media",
142 | contexts: ["audio", "video", "image"],
143 | icons: icons,
144 | });
145 |
146 | browser.menus.create({
147 | id: "store-link",
148 | title: "Store Link",
149 | contexts: ["link"],
150 | icons: icons,
151 | });
152 |
153 | browser.menus.create({
154 | id: "capture-link",
155 | title: "Capture Link",
156 | contexts: ["link"],
157 | icons: icons,
158 | });
159 |
160 | browser.menus.create({
161 | id: "store-page-link",
162 | title: "Store Page Link",
163 | contexts: ["page", "tab"],
164 | icons: icons,
165 | });
166 |
167 | browser.menus.create({
168 | id: "capture-page-link",
169 | title: "Capture Page Link",
170 | contexts: ["page", "tab"],
171 | icons: icons,
172 | });
173 |
174 | browser.menus.onClicked.addListener(async (info, tab) => {
175 | switch (info.menuItemId) {
176 | case "store-link":
177 | await storeLink(info.linkUrl, info.linkText);
178 | return;
179 | case "store-page-link":
180 | await storeLink(tab.url, tab.title);
181 | return;
182 | case "capture-selection":
183 | const html = await getSetting("captureHtml");
184 | const selection = html ? await getSelection(tab, html) : info.selectionText;
185 | await capture("selection", tab.url, tab.title, selection, html);
186 | return;
187 | case "capture-link":
188 | await capture("link", info.linkUrl, info.linkText, null);
189 | return;
190 | case "capture-page-link":
191 | const description = await getDescription(tab);
192 | await capture("link", tab.url, tab.title, description);
193 | return;
194 | case "capture-media":
195 | const downloadMedia = await getSetting("downloadMedia");
196 | if (!downloadMedia) {
197 | await capture("media", tab.url, tab.title, info.srcUrl);
198 | return;
199 | }
200 | await browser.storage.local.set({
201 | [`_dl.${info.srcUrl}`]: { pageUrl: tab.url, pageTitle: tab.title, mediaUrl: info.srcUrl }
202 | });
203 | await browser.downloads.download({
204 | cookieStoreId: tab.cookieStoreId,
205 | saveAs: false,
206 | conflictAction: "uniquify",
207 | url: info.srcUrl,
208 | });
209 | return;
210 | default:
211 | throw new Error(`unknown menu item ${info.menuItemId}`);
212 | }
213 | });
214 |
215 | browser.commands.onCommand.addListener(async (action) => {
216 | const [tab] = await browser.tabs.query({ currentWindow: true, active: true });
217 | switch (action) {
218 | case "store":
219 | await storeLink(tab.url, tab.title);
220 | return;
221 | case "capture":
222 | await autoCapture(tab);
223 | return;
224 | default:
225 | throw new Error(`unknown command ${action}`);
226 | }
227 | });
228 |
229 | browser.downloads.onChanged.addListener(async (change) => {
230 | // We're looking for newly finished downloads.
231 | if (change.state.previous == 'complete' || change.state.current != 'complete') {
232 | return;
233 | }
234 |
235 | let [dl] = await browser.downloads.search({ id: change.id });
236 | if (!dl) {
237 | return;
238 | }
239 |
240 | if (dl.byExtensionId != browser.runtime.id) {
241 | return;
242 | }
243 |
244 | const key = `_dl.${dl.url}`;
245 | const { [key]: metadata } = await browser.storage.local.get(key);
246 | if (!metadata) {
247 | return;
248 | }
249 |
250 | await capture("media", metadata.pageUrl, metadata.pageTitle, `file:${dl.filename}`);
251 | await browser.storage.local.remove(key);
252 | });
253 |
254 | (function() {
255 | Object.entries(browser.storage.local.get())
256 | .filter(([key, _]) => key.startsWith("_dl."))
257 | .forEach(async ([k, v]) => {
258 | let [dl] = await browser.downloads.search({ url: v.mediaUrl });
259 | if (!dl) {
260 | await browser.storage.local.remove(k);
261 | return;
262 | }
263 | if (dl.state == "complete") {
264 | await capture("media", metadata.pageUrl, metadata.pageTitle, `file:${dl.filename}`);
265 | await browser.storage.local.remove(k);
266 | }
267 | });
268 | })();
269 |
--------------------------------------------------------------------------------
/emacs.svg:
--------------------------------------------------------------------------------
1 |
2 |
287 |
--------------------------------------------------------------------------------
/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | "manifest_version": 2,
3 | "name": "Org Capture",
4 | "version": "0.3.0",
5 | "browser_specific_settings": {
6 | "gecko": {
7 | "id": "org-capture@stebalien.com"
8 | }
9 | },
10 | "author": "Steven Allen",
11 | "description": "A web-extension for capturing pages/media with org-capture.",
12 | "homepage_url": "https://github.com/Stebalien/org-capture-extension",
13 |
14 | "background": {
15 | "persistent": false,
16 | "scripts": ["settings.js", "background.js"]
17 | },
18 |
19 | "permissions": ["activeTab", "storage", "scripting", "menus", "downloads", "cookies"],
20 |
21 | "options_ui": {
22 | "page": "options.html"
23 | },
24 |
25 | "browser_action": {
26 | "default_icon": "emacs.svg"
27 | },
28 |
29 | "icons": {
30 | "48": "emacs.svg",
31 | "96": "emacs.svg"
32 | },
33 |
34 | "commands": {
35 | "capture": {
36 | "description": "Capture current page with org-capture",
37 | "suggested_key": {
38 | "default": "Ctrl+Shift+C",
39 | "mac": "Command+Shift+C"
40 | }
41 | },
42 | "store": {
43 | "description": "Store a link to the current page",
44 | "suggested_key": {
45 | "default": "Ctrl+Shift+L",
46 | "mac": "Command+Shift+L"
47 | }
48 | }
49 | }
50 | }
51 |
--------------------------------------------------------------------------------
/options.css:
--------------------------------------------------------------------------------
1 | * {
2 | margin: 2px;
3 | }
4 | tbody th {
5 | text-align: right;
6 | }
7 | thead th {
8 | text-align: left;
9 | }
10 |
--------------------------------------------------------------------------------
/options.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Org Capture Settings
5 |
6 |
7 |
8 |
9 |
75 |
76 |
77 |
78 |
79 |
--------------------------------------------------------------------------------
/options.js:
--------------------------------------------------------------------------------
1 | window.addEventListener("DOMContentLoaded", async (_event) => {
2 | const form = document.getElementById('options');
3 |
4 | form.addEventListener('input', function(event) {
5 | const key = event.target.name;
6 | if (!key) {
7 | return;
8 | }
9 | if (event.target.type === 'checkbox') {
10 | setSetting(key, event.target.checked);
11 | } else if (event.target.value === "") {
12 | clearSetting(key);
13 | } else {
14 | setSetting(key, event.target.value);
15 | }
16 | });
17 |
18 | const settings = await browser.storage.sync.get(
19 | Object.fromEntries(Object.keys(DEFAULTS).map((k) => [k, undefined])),
20 | );
21 |
22 | for (const [key, value] of Object.entries(settings)) {
23 | const element = form.elements[key];
24 | if (element.type == 'checkbox') {
25 | element.checked = value ?? DEFAULTS[key];
26 | } else {
27 | element.placeholder = DEFAULTS[key];
28 | if (value != null) {
29 | element.value = value;
30 | }
31 | }
32 | }
33 | });
34 |
--------------------------------------------------------------------------------
/settings.js:
--------------------------------------------------------------------------------
1 | const DEFAULTS = {
2 | captureHtml: false,
3 | selectionCaptureTemplate: "s",
4 | selectionCaptureProtocol: "capture",
5 | mediaCaptureTemplate: "m",
6 | mediaCaptureProtocol: "capture",
7 | linkCaptureTemplate: "l",
8 | linkCaptureProtocol: "capture",
9 | defaultAction: "store",
10 | downloadMedia: true,
11 | };
12 |
13 | async function getSetting(key) {
14 | const { [key]: result } = await browser.storage.sync.get({ [key]: DEFAULTS[key] });
15 | return result;
16 | }
17 |
18 | async function setSetting(key, value) {
19 | return browser.storage.sync.set({ [key]: value });
20 | }
21 |
22 | async function clearSetting(key) {
23 | return browser.storage.sync.remove(key);
24 | }
25 |
--------------------------------------------------------------------------------