├── .eslintrc.js ├── .github └── FUNDING.yml ├── .gitignore ├── .prettierrc.js ├── LICENSE ├── PATENTS ├── README.md ├── package.json ├── preload.js ├── src ├── browser │ ├── background-pages.ts │ ├── browser-action.ts │ ├── cookies.ts │ ├── handler-factory.ts │ ├── index.ts │ ├── tabs.ts │ ├── web-navigation.ts │ ├── web-request-api.ts │ ├── web-request-electron.ts │ └── windows.ts ├── constants.ts ├── index.ts ├── interfaces │ └── tabs.ts ├── models │ ├── ipc-event.ts │ └── web-request-event.ts ├── renderer │ ├── api.ts │ ├── index.ts │ └── ipc-invoker.ts └── utils │ ├── images.ts │ ├── session.ts │ ├── string.ts │ ├── url.ts │ ├── web-contents.ts │ └── web-request.ts ├── tsconfig.json ├── webpack.config.js └── yarn.lock /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | parser: '@typescript-eslint/parser', 3 | extends: [ 4 | 'plugin:@typescript-eslint/recommended', 5 | 'prettier/@typescript-eslint', 6 | 'plugin:prettier/recommended', 7 | ], 8 | parserOptions: { 9 | ecmaVersion: 2018, 10 | sourceType: 'module', 11 | }, 12 | rules: { 13 | '@typescript-eslint/explicit-function-return-type': 'off', 14 | '@typescript-eslint/interface-name-prefix': 'off', 15 | '@typescript-eslint/no-empty-function': 'off' 16 | } 17 | }; -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: [sentialx] 2 | patreon: sentialx 3 | custom: https://paypal.me/sentialx 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | *.log 3 | *.log* 4 | build 5 | .DS_Store -------------------------------------------------------------------------------- /.prettierrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | semi: true, 3 | trailingComma: 'all', 4 | singleQuote: true, 5 | tabWidth: 2, 6 | }; -------------------------------------------------------------------------------- /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 | electron-extensions 635 | Copyright (C) 2019 Eryk Rakowski (sentialx@gmail.com) 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 | electron-extensions Copyright (C) 2019 Eryk Rakowski (sentialx@gmail.com) 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 | . -------------------------------------------------------------------------------- /PATENTS: -------------------------------------------------------------------------------- 1 | Additional Grant of Patent 2 | 3 | A perpetual, non-exclusive, irrevocable license, under any necessary claims, to 4 | make, have made, use, import and otherwise transfer the electron-extensions software, is 5 | hereby granted to each recipient ("you") of the electron-extensions software distributed by 6 | Eryk Rakowski. 7 | 8 | The license granted hereunder will terminate, automatically and without notice, 9 | if you (or any of your subsidiaries, corporate affiliates or agents) initiate 10 | directly or indirectly, or take a direct financial interest in. 11 | 12 | (1) This software may not be sold to a third party nor redistributed or 13 | otherwise conveyed in the original form. 14 | 15 | (2) No recipient or contributor is allowed to ask and receive any donations for 16 | his copy of electron-extensions software. 17 | 18 | (3) A written permission from the main maintainer of electron-extensions software (Eryk 19 | Rakowski) is necessary if a recipient or contributor decides to sell or 20 | publish the software on official stores or intents to realize any economic 21 | gains. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # electron-extensions 2 | 3 | `electron-extensions` will allow you to use Chrome extensions APIs with Electron. 4 | 5 | # Installation 6 | 7 | ```bash 8 | $ npm install electron-extensions 9 | ``` 10 | 11 | # Usage 12 | 13 | The library is really easy-to-use. All you have to do is to put the following code in your main process: 14 | 15 | ```typescript 16 | import { ExtensibleSession } from 'electron-extensions/main'; 17 | import { app } from 'electron'; 18 | 19 | const extensions = new ExtensibleSession(); 20 | 21 | (async () => { 22 | await app.whenReady(); 23 | extensions.loadExtension('C:/.../abcdefghijklmnoprstuwxyz'); // Path to the extension to load 24 | })(); 25 | ``` 26 | 27 | # Documentation 28 | 29 | ## Class `ExtensibleSession` `main` 30 | 31 | ### `new ExtensibleSession(options: IOptions)` 32 | 33 | - `options` object 34 | - `partition` string - By default `null`. It's used for injecting preloads to 35 | load `content_scripts` in all webContents within a given Electron `session`. Must be called in `app` `ready` event. 36 | - `preloadPath` string - Path to content preload script. The option can be useful for bundlers like `webpack` if you're using `CopyWebpackPlugin`. 37 | - `blacklist` string[] - List of URLs or glob patterns preventing from injecting `content_scripts` to. For example `[wexond://*/*]`. 38 | 39 | It's only for the main process. It's used to load extensions and handle their events. 40 | 41 | ### Instance methods 42 | 43 | #### `loadExtension(path: string)` 44 | 45 | Loads an extension from a given path. 46 | 47 | #### `addWindow(window: Electron.BrowserWindow)` 48 | 49 | Adds a BrowserWindow to send and observe UI related events such as 50 | 51 | - `chrome.browserAction.onClicked` 52 | 53 | ### Instance properties 54 | 55 | #### `blacklist` string[] 56 | 57 | List of URLs or glob patterns preventing from injecting `content_scripts` to. For example `[wexond://*]`. 58 | 59 | ### Events 60 | 61 | #### `set-badge-text` 62 | 63 | Emitted when `chrome.browserAction.setBadgeText` has been called in an extension. 64 | 65 | Returns: 66 | 67 | - `extensionId` string 68 | - `details` chrome.browserAction.BadgeTextDetails 69 | 70 | #### `create-tab` 71 | 72 | Emitted when `chrome.tabs.create` has been called in an extension. 73 | 74 | ##### Example: 75 | 76 | ```typescript 77 | import { extensionsRenderer } from 'electron-extensions'; 78 | 79 | extensionsRenderer.on('create-tab', (details, callback) => { 80 | const tab = createTab(details); // Some create tab method... 81 | callback(tab.id); 82 | }); 83 | ``` 84 | 85 | Returns: 86 | 87 | - `details` chrome.tabs.CreateProperties 88 | - `callback` (tabId: number) => void - Must be called with the created tab id as an argument. Also, the `tabId` must be the same as any attached `webContents` id 89 | 90 | ## Object `extensionsRenderer` 91 | 92 | ### Usage in `renderer` 93 | 94 | ```typescript 95 | import { extensionsRenderer } from 'electron-extensions/renderer'; 96 | ``` 97 | 98 | ### Instance methods 99 | 100 | #### `browserAction.onClicked(extensionId: string, tabId: number)` 101 | 102 | Emits `chrome.browserAction.onClicked` event in a given extension. 103 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "electron-extensions", 3 | "version": "7.0.0-beta.3", 4 | "description": "Implementation of Chrome extension APIs for Electron", 5 | "homepage": "https://github.com/sentialx/electron-extensions#readme", 6 | "main": "./build/index.js", 7 | "types": "./build/index.d.ts", 8 | "repository": { 9 | "type": "git", 10 | "url": "git+https://github.com/sentialx/electron-extensions.git" 11 | }, 12 | "bugs": { 13 | "url": "https://github.com/sentialx/electron-extensions/issues" 14 | }, 15 | "scripts": { 16 | "lint": "eslint \"src/**/*.ts*\"", 17 | "lint-fix": "npm run lint -- --fix", 18 | "watch": "cross-env ENV='dev' webpack", 19 | "build": "webpack", 20 | "prepare": "npm run build" 21 | }, 22 | "pre-commit": [ 23 | "lint-fix" 24 | ], 25 | "files": [ 26 | "LICENSE", 27 | "preload.js", 28 | "build", 29 | "README.md" 30 | ], 31 | "devDependencies": { 32 | "@types/chrome": "0.0.104", 33 | "@types/node": "13.13.2", 34 | "@types/uuid": "^7.0.3", 35 | "@typescript-eslint/eslint-plugin": "^2.29.0", 36 | "@typescript-eslint/parser": "^2.29.0", 37 | "cross-env": "^7.0.2", 38 | "electron": "^9.0.0-beta.16", 39 | "eslint": "^6.8.0", 40 | "eslint-config-prettier": "^6.11.0", 41 | "eslint-plugin-prettier": "^3.1.3", 42 | "prettier": "2.0.5", 43 | "ts-loader": "^7.0.1", 44 | "typescript": "3.8.3", 45 | "uuid": "^7.0.3", 46 | "webpack": "^4.43.0", 47 | "webpack-cli": "^3.3.11", 48 | "webpack-merge": "^4.2.2" 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /preload.js: -------------------------------------------------------------------------------- 1 | require('./build/preload.js'); 2 | -------------------------------------------------------------------------------- /src/browser/background-pages.ts: -------------------------------------------------------------------------------- 1 | import { app, webContents } from 'electron'; 2 | import { parse } from 'url'; 3 | import { EventEmitter } from 'events'; 4 | import { PROTOCOL_SCHEME } from '../constants'; 5 | import { isBackgroundPage } from '../utils/web-contents'; 6 | 7 | export const sendToExtensionPages = (channel: string, ...args: any[]) => { 8 | webContents.getAllWebContents().forEach((wc) => { 9 | if (wc.isDestroyed() || !wc.getURL().startsWith(PROTOCOL_SCHEME)) return; 10 | wc.send(channel, ...args); 11 | }); 12 | }; 13 | 14 | export declare interface BackgroundPages { 15 | on( 16 | event: 'created', 17 | listener: (webContents: Electron.WebContents) => void, 18 | ): this; 19 | on(event: string, listener: Function): this; 20 | } 21 | 22 | export class BackgroundPages extends EventEmitter { 23 | public constructor() { 24 | super(); 25 | 26 | app.on('web-contents-created', (e, wc) => { 27 | if (isBackgroundPage(wc)) { 28 | this.emit('created', webContents); 29 | } 30 | }); 31 | } 32 | 33 | public get(extensionId: string, session: Electron.Session) { 34 | return webContents 35 | .getAllWebContents() 36 | .find( 37 | (x) => 38 | isBackgroundPage(x) && 39 | parse(x.getURL()).hostname === extensionId && 40 | x.session === session, 41 | ); 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/browser/browser-action.ts: -------------------------------------------------------------------------------- 1 | import { EventEmitter } from 'events'; 2 | import { sessionFromIpcEvent } from '../utils/session'; 3 | import { webContents } from 'electron'; 4 | import { isAbsolute } from 'path'; 5 | import { PROTOCOL_SCHEME } from '../constants'; 6 | import { HandlerFactory } from './handler-factory'; 7 | 8 | type IconType = string | { [key: string]: string }; 9 | 10 | interface IBrowserActionInfo { 11 | icon?: IconType; 12 | popup?: string; 13 | title?: string; 14 | badgeText?: string; 15 | badgeBackgroundColor?: string | number[]; 16 | } 17 | 18 | interface IBrowserAction extends IBrowserActionInfo { 19 | baseUrl: string; 20 | extensionId: string; 21 | tabs: Map; 22 | } 23 | 24 | const CHROME_DETAILS_KEYS: { [key: string]: string } = { 25 | badgeText: 'text', 26 | badgeBackgroundColor: 'color', 27 | title: 'title', 28 | }; 29 | 30 | const resolvePath = (extensionUrl: string, path: string) => { 31 | if (!path) return undefined; 32 | if (path.startsWith(extensionUrl) || isAbsolute(path)) return path; 33 | return `${extensionUrl}${path}`; 34 | }; 35 | 36 | const resolveIconPaths = (extensionUrl: string, icon: IconType): IconType => { 37 | if (typeof icon === 'object') { 38 | const newIcon: IconType = {}; 39 | Object.entries(icon).forEach(([key, value]) => { 40 | if (typeof value === 'string') { 41 | newIcon[key] = resolvePath(extensionUrl, value); 42 | } 43 | }); 44 | return newIcon; 45 | } 46 | 47 | if (typeof icon === 'string') { 48 | return resolvePath(extensionUrl, icon); 49 | } 50 | 51 | return undefined; 52 | }; 53 | 54 | export declare interface BrowserActionAPI { 55 | on(event: 'updated', listener: (action: IBrowserAction) => void): this; 56 | on(event: 'loaded', listener: (action: IBrowserAction) => void): this; 57 | on(event: string, listener: Function): this; 58 | } 59 | 60 | export class BrowserActionAPI extends EventEmitter { 61 | private sessionActionMap: Map< 62 | Electron.Session, 63 | Map 64 | > = new Map(); 65 | 66 | constructor() { 67 | super(); 68 | 69 | const setter = (propName: string) => ( 70 | e: Electron.IpcMainEvent, 71 | extensionId: string, 72 | details: chrome.browserAction.BadgeBackgroundColorDetails & 73 | chrome.browserAction.BadgeTextDetails & 74 | chrome.browserAction.TitleDetails & 75 | chrome.browserAction.PopupDetails & 76 | chrome.browserAction.TabIconDetails, 77 | ) => { 78 | const ses = sessionFromIpcEvent(e); 79 | const action = this.getOrCreate(ses, extensionId); 80 | const { tabId } = details; 81 | 82 | let newValue: any = (details as any)[CHROME_DETAILS_KEYS[propName]]; 83 | 84 | if (propName === 'icon') { 85 | newValue = 86 | details.imageData || resolveIconPaths(action.baseUrl, details.path); 87 | } else if (propName === 'popup') { 88 | newValue = resolvePath(action.baseUrl, details.popup); 89 | } 90 | 91 | let actionToUpdate: any = action; 92 | 93 | if (tabId) { 94 | if (action.tabs.has(tabId)) { 95 | actionToUpdate = action.tabs.get(tabId); 96 | } else { 97 | actionToUpdate = {}; 98 | action.tabs.set(tabId, actionToUpdate); 99 | } 100 | } 101 | 102 | if (actionToUpdate[propName] !== newValue) { 103 | actionToUpdate[propName] = newValue; 104 | this.emit('updated', action); 105 | } 106 | }; 107 | 108 | const handler = HandlerFactory.create('browserAction', this); 109 | 110 | [ 111 | 'title', 112 | 'icon', 113 | 'popup', 114 | 'badgeBackgroundColor', 115 | 'badgeText', 116 | ].forEach((prop) => 117 | handler( 118 | `set${prop.charAt(0).toUpperCase()}${prop.substring(1)}`, 119 | setter(prop), 120 | true, 121 | ), 122 | ); 123 | 124 | handler('getAll', this.getAllHandler, true); 125 | 126 | handler('getAllInTab', this.getAllInTab); 127 | handler('onClicked', this.onClicked); 128 | } 129 | 130 | private getAllHandler(event: Electron.IpcMainEvent) { 131 | return this.getAllInSession(sessionFromIpcEvent(event)); 132 | } 133 | 134 | private getOrCreate(session: Electron.Session, extensionId: string) { 135 | let sessionActions = this.sessionActionMap.get(session); 136 | if (!sessionActions) { 137 | sessionActions = new Map(); 138 | this.sessionActionMap.set(session, sessionActions); 139 | } 140 | 141 | let action = sessionActions.get(extensionId); 142 | if (!action) { 143 | action = { 144 | tabs: new Map(), 145 | extensionId, 146 | baseUrl: `${PROTOCOL_SCHEME}${extensionId}/`, 147 | }; 148 | sessionActions.set(extensionId, action); 149 | } 150 | 151 | return action; 152 | } 153 | 154 | public loadFromManifest( 155 | session: Electron.Session, 156 | extension: Electron.Extension, 157 | ): IBrowserAction { 158 | const { browser_action: browserAction } = extension.manifest || {}; 159 | 160 | if (!browserAction) return null; 161 | 162 | const { 163 | default_popup: popup, 164 | default_title: title, 165 | default_icon: icon, 166 | } = browserAction; 167 | 168 | const action = this.getOrCreate(session, extension.id); 169 | Object.assign(action, { 170 | popup: resolvePath(extension.url, popup), 171 | icon: resolveIconPaths(extension.url, icon), 172 | title, 173 | }); 174 | 175 | this.emit('loaded', action); 176 | 177 | return action; 178 | } 179 | 180 | public getAllInSession(session: Electron.Session): IBrowserAction[] { 181 | const sessionActions = this.sessionActionMap.get(session); 182 | if (!sessionActions) return []; 183 | return Array.from(sessionActions.values()); 184 | } 185 | 186 | public getAllInTab(tabId: number): IBrowserAction[] { 187 | const tab = webContents.fromId(tabId); 188 | if (!tab) return []; 189 | 190 | const { session } = tab; 191 | const actions = this.getAllInSession(session); 192 | 193 | return actions.map((action) => 194 | action.tabs.has(tabId) 195 | ? { 196 | ...action, 197 | ...action.tabs.get(tabId), 198 | } 199 | : action, 200 | ); 201 | } 202 | 203 | // TODO(sentialx): Tab in callback, fire if the browser action has no popup. 204 | public onClicked(extensionId: string) { 205 | this.emit('clicked', extensionId); 206 | } 207 | } 208 | -------------------------------------------------------------------------------- /src/browser/cookies.ts: -------------------------------------------------------------------------------- 1 | import { sessionFromIpcEvent } from '../utils/session'; 2 | import { HandlerFactory } from './handler-factory'; 3 | import { sendToExtensionPages } from './background-pages'; 4 | 5 | const ELECTRON_TO_CHROME_COOKIE_CHANGE_CAUSE: { [key: string]: string } = { 6 | explicit: 'explicit', 7 | overwrite: 'overwrite', 8 | expired: 'expired', 9 | evicted: 'evicted', 10 | 'expired-overwrite': 'expired_overwrite', 11 | }; 12 | 13 | export class CookiesAPI { 14 | constructor() { 15 | const handler = HandlerFactory.create('cookies', this); 16 | 17 | handler('get', this.get, true); 18 | handler('getAll', this.getAll, true); 19 | handler('set', this.set, true); 20 | handler('remove', this.remove, true); 21 | } 22 | 23 | public observeSession(ses: Electron.Session) { 24 | ses.cookies.on( 25 | 'changed', 26 | (e: any, electronCookie: any, electronCause: any, removed: any) => { 27 | const cookie = this.getChromeCookie(electronCookie); 28 | const cause = ELECTRON_TO_CHROME_COOKIE_CHANGE_CAUSE[electronCause]; 29 | 30 | const details = { 31 | cookie, 32 | cause, 33 | removed, 34 | }; 35 | 36 | sendToExtensionPages('cookies.onChanged', details); 37 | }, 38 | ); 39 | } 40 | 41 | private getChromeCookie(cookie: Electron.Cookie): chrome.cookies.Cookie { 42 | return { 43 | name: cookie.name, 44 | value: cookie.value, 45 | domain: cookie.domain, 46 | hostOnly: cookie.hostOnly, 47 | path: cookie.path, 48 | secure: cookie.secure, 49 | httpOnly: cookie.httpOnly, 50 | sameSite: 'no_restriction', 51 | session: cookie.session, 52 | expirationDate: cookie.expirationDate, 53 | storeId: '0', 54 | }; 55 | } 56 | 57 | private async getAll( 58 | e: Electron.IpcMainEvent, 59 | details: chrome.cookies.Cookie & { url: string }, 60 | ) { 61 | const { url, name, domain, path, secure, session } = details; 62 | 63 | const cookies = await sessionFromIpcEvent(e).cookies.get({ 64 | url, 65 | name, 66 | domain, 67 | path, 68 | secure, 69 | session, 70 | }); 71 | 72 | if (cookies) { 73 | return cookies.map((c) => this.getChromeCookie(c)); 74 | } 75 | 76 | return []; 77 | } 78 | 79 | private async get(e: Electron.IpcMainEvent, details: chrome.cookies.Details) { 80 | const { url, name } = details; 81 | 82 | const cookies = await sessionFromIpcEvent(e).cookies.get({ url, name }); 83 | 84 | if (cookies && cookies[0]) { 85 | const cookie = cookies[0]; 86 | return this.getChromeCookie(cookie); 87 | } 88 | 89 | return null; 90 | } 91 | 92 | private async set( 93 | e: Electron.IpcMainEvent, 94 | details: { url: string } & Partial, 95 | ): Promise> { 96 | const { 97 | url, 98 | name, 99 | value, 100 | domain, 101 | path, 102 | secure, 103 | httpOnly, 104 | expirationDate, 105 | } = details; 106 | 107 | await sessionFromIpcEvent(e).cookies.set({ 108 | url, 109 | name, 110 | value, 111 | domain, 112 | path, 113 | secure, 114 | httpOnly, 115 | expirationDate, 116 | }); 117 | 118 | return { 119 | name, 120 | value, 121 | domain, 122 | path, 123 | secure, 124 | httpOnly, 125 | expirationDate, 126 | storeId: null, 127 | }; 128 | } 129 | 130 | private async remove( 131 | e: Electron.IpcMainEvent, 132 | details: chrome.cookies.Details, 133 | ): Promise> { 134 | const { url, name } = details; 135 | 136 | await sessionFromIpcEvent(e).cookies.remove(url, name); 137 | return { url, name, storeId: null }; 138 | } 139 | } 140 | -------------------------------------------------------------------------------- /src/browser/handler-factory.ts: -------------------------------------------------------------------------------- 1 | import { ipcMain } from 'electron'; 2 | 3 | export class HandlerFactory { 4 | public static create(scope: string, bind: any) { 5 | return (name: string, fn: (...args: any[]) => void, includeEvent = false) => 6 | ipcMain.handle(`${scope}.${name}`, (...args: any[]) => { 7 | if (!includeEvent) args = args.slice(1); 8 | return fn.bind(bind)(...args); 9 | }); 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /src/browser/index.ts: -------------------------------------------------------------------------------- 1 | import { CookiesAPI } from './cookies'; 2 | import { TabsAPI } from './tabs'; 3 | import { BackgroundPages } from './background-pages'; 4 | import { WindowsAPI } from './windows'; 5 | import { hookExtensionWebRequestBypass } from './web-request-electron'; 6 | import { WebRequestAPI } from './web-request-api'; 7 | import { BrowserActionAPI } from './browser-action'; 8 | 9 | export class Extensions { 10 | public static instance = new Extensions(); 11 | 12 | public tabs = new TabsAPI(); 13 | public cookies = new CookiesAPI(); 14 | public windows = new WindowsAPI(); 15 | public webRequest = new WebRequestAPI(); 16 | public browserAction = new BrowserActionAPI(); 17 | 18 | public backgroundPages = new BackgroundPages(); 19 | 20 | public initializeSession(session: Electron.Session, preloadPath: string) { 21 | if (session.getPreloads().includes(preloadPath)) { 22 | throw new Error( 23 | 'Extension preload has already been injected into this Session.', 24 | ); 25 | } 26 | session.setPreloads(session.getPreloads().concat(preloadPath)); 27 | 28 | hookExtensionWebRequestBypass(session); 29 | this.cookies.observeSession(session); 30 | } 31 | } 32 | 33 | export const extensions = Extensions.instance; 34 | 35 | export * from '../utils/session'; 36 | -------------------------------------------------------------------------------- /src/browser/tabs.ts: -------------------------------------------------------------------------------- 1 | import { Tab } from '../interfaces/tabs'; 2 | import { BrowserWindow } from 'electron'; 3 | import { promises } from 'fs'; 4 | import { resolve } from 'path'; 5 | import { sessionFromIpcEvent } from '../utils/session'; 6 | import { sendToExtensionPages } from './background-pages'; 7 | import { EventEmitter } from 'events'; 8 | import { Extensions } from '.'; 9 | import { HandlerFactory } from './handler-factory'; 10 | 11 | export const getParentWindowOfTab = (tab: Tab) => { 12 | switch (tab.getType()) { 13 | case 'window': 14 | return BrowserWindow.fromWebContents(tab); 15 | case 'browserView': 16 | case 'webview': 17 | return (tab as any).getOwnerBrowserWindow(); 18 | } 19 | return undefined; 20 | }; 21 | 22 | // Events which can be registered only once 23 | interface ITabsEvents { 24 | onCreateDetails: (tab: Tab, details: chrome.tabs.Tab) => void; 25 | onCreate: (details: chrome.tabs.CreateProperties) => Promise; 26 | } 27 | 28 | export declare interface TabsAPI { 29 | on( 30 | event: 'updated', 31 | listener: ( 32 | tabId: number, 33 | changeInfo: chrome.tabs.TabChangeInfo, 34 | details: chrome.tabs.Tab, 35 | ) => void, 36 | ): this; 37 | on( 38 | event: 'activated', 39 | listener: ( 40 | tabId: number, 41 | windowId: number, 42 | ...additionalArgs: any[] 43 | ) => void, 44 | ): this; 45 | on(event: 'will-remove', listener: (tabId: number) => void): this; 46 | on(event: string, listener: Function): this; 47 | } 48 | 49 | type DetailsType = chrome.tabs.Tab & { [key: string]: string }; 50 | 51 | export class TabsAPI extends EventEmitter implements ITabsEvents { 52 | private tabs: Set = new Set(); 53 | private detailsCache: Map = new Map(); 54 | 55 | constructor() { 56 | super(); 57 | 58 | const handler = HandlerFactory.create('tabs', this); 59 | 60 | handler('get', this.get); 61 | handler('getSelected', this.getSelected); 62 | handler('getAllInWindow', this.getAllInWindow); 63 | handler('query', this.query); 64 | handler('update', this.update); 65 | handler('reload', this.reload); 66 | handler('create', this.create); 67 | handler('remove', this.remove); 68 | 69 | handler('getCurrent', this.getCurrent, true); 70 | handler('insertCSS', this.insertCSS, true); 71 | } 72 | 73 | onCreateDetails: (tab: Tab, details: chrome.tabs.Tab) => void; 74 | onCreate: (details: chrome.tabs.CreateProperties) => Promise; 75 | 76 | public async update( 77 | tabId: number, 78 | updateProperties: chrome.tabs.UpdateProperties, 79 | ) { 80 | const tab = this.getTabById(tabId); 81 | if (!tab) return null; 82 | 83 | const { url, muted, active } = updateProperties; 84 | 85 | // TODO: validate URL, prevent 'javascript:' 86 | if (url) await tab.loadURL(url); 87 | 88 | if (typeof muted === 'boolean') tab.setAudioMuted(muted); 89 | 90 | if (active) this.activate(tabId); 91 | 92 | this.onUpdated(tab); 93 | 94 | return this.createDetails(tab); 95 | } 96 | 97 | public activate(tabId: number, ...additionalArgs: any[]) { 98 | const tab = this.getTabById(tabId); 99 | if (!tab) return; 100 | 101 | const details = this.getDetails(tab); 102 | 103 | const activeChanged = !details.active; 104 | 105 | this.detailsCache.forEach((tabInfo, cacheTab) => { 106 | tabInfo.active = tabId === cacheTab.id; 107 | }); 108 | 109 | if (!activeChanged) return; 110 | 111 | this.emit('activated', tab.id, details.windowId, ...additionalArgs); 112 | sendToExtensionPages('tabs.onActivated', { 113 | tabId, 114 | windowId: details.windowId, 115 | }); 116 | } 117 | 118 | public get(tabId: number): chrome.tabs.Tab { 119 | const tab = this.getTabById(tabId); 120 | return this.getDetails(tab); 121 | } 122 | 123 | public remove(tabIds: number | number[]) { 124 | if (Array.isArray(tabIds)) { 125 | tabIds.forEach((id) => this.emit('will-remove', id)); 126 | return; 127 | } 128 | 129 | this.emit('will-remove', tabIds); 130 | } 131 | 132 | // This API is deprecated, so we fallback it to chrome.tabs.query({ windowId }) 133 | public getAllInWindow(windowId: number) { 134 | return this.query({ windowId }); 135 | } 136 | 137 | // Deprecated, fallback to chrome.tabs.query 138 | public getSelected(windowId: number) { 139 | if (typeof windowId === 'number') { 140 | return this.query({ windowId, active: true })[0]; 141 | } 142 | return this.query({ active: true })[0]; 143 | } 144 | 145 | public query(info: chrome.tabs.QueryInfo = {}) { 146 | const isSet = (value: any) => typeof value !== 'undefined'; 147 | 148 | const tabs = Array.from(this.tabs) 149 | .map(this.getDetails) 150 | .filter((tab) => { 151 | if (isSet(info.active) && info.active !== tab.active) return false; 152 | if (isSet(info.pinned) && info.pinned !== tab.pinned) return false; 153 | if (isSet(info.audible) && info.audible !== tab.audible) return false; 154 | if (isSet(info.muted) && info.muted !== tab.mutedInfo.muted) 155 | return false; 156 | if (isSet(info.highlighted) && info.highlighted !== tab.highlighted) 157 | return false; 158 | if (isSet(info.discarded) && info.discarded !== tab.discarded) 159 | return false; 160 | if ( 161 | isSet(info.autoDiscardable) && 162 | info.autoDiscardable !== tab.autoDiscardable 163 | ) 164 | return false; 165 | if (isSet(info.status) && info.status !== tab.status) return false; 166 | if (isSet(info.windowId) && info.windowId !== tab.windowId) 167 | return false; 168 | if (isSet(info.title) && info.title !== tab.title) return false; // TODO: pattern match 169 | if ( 170 | isSet(info.url) && 171 | info.url !== tab.url && 172 | info.url !== '' 173 | ) 174 | return false; // TODO: match URL pattern 175 | // if (isSet(info.currentWindow)) return false 176 | // if (isSet(info.lastFocusedWindow)) return false 177 | // if (isSet(info.windowType) && info.windowType !== tab.windowType) return false 178 | // if (isSet(info.index) && info.index !== tab.index) return false 179 | return true; 180 | }) 181 | .map((tab, index) => { 182 | tab.index = index; 183 | return tab; 184 | }); 185 | 186 | return tabs; 187 | } 188 | 189 | public async create( 190 | details: chrome.tabs.CreateProperties, 191 | ): Promise { 192 | if (!this.onCreate) { 193 | throw new Error('No onCreate event handler'); 194 | } 195 | 196 | const tabId = await this.onCreate(details); 197 | const tab = this.getTabById(tabId); 198 | return this.getDetails(tab); 199 | } 200 | 201 | public observe(tab: Tab) { 202 | this.tabs.add(tab); 203 | 204 | tab.once('destroyed', () => { 205 | this.tabs.delete(tab); 206 | this.onRemoved(tab); 207 | }); 208 | 209 | const updateEvents: any[] = [ 210 | 'page-title-updated', // title 211 | 'did-start-loading', // status 212 | 'did-stop-loading', // status 213 | 'media-started-playing', // audible 214 | 'media-paused', // audible 215 | 'did-start-navigation', // url 216 | 'did-redirect-navigation', // url 217 | 'did-navigate-in-page', // url 218 | ]; 219 | 220 | updateEvents.forEach((eventName) => { 221 | tab.on(eventName, () => { 222 | this.onUpdated(tab); 223 | }); 224 | }); 225 | 226 | tab.on('page-favicon-updated', (event, favicons) => { 227 | tab.favicon = favicons[0]; 228 | this.onUpdated(tab); 229 | }); 230 | 231 | this.onCreated(tab); 232 | } 233 | 234 | public reload( 235 | tabId: number, 236 | reloadProperties: chrome.tabs.ReloadProperties = {}, 237 | ) { 238 | const tab = this.getTabById(tabId); 239 | if (!tab) return; 240 | 241 | if (reloadProperties.bypassCache) { 242 | tab.reloadIgnoringCache(); 243 | } else { 244 | tab.reload(); 245 | } 246 | } 247 | 248 | public getTabById(id: number) { 249 | return Array.from(this.tabs).find((x) => x.id === id); 250 | } 251 | 252 | public getDetails = (tab: Tab): chrome.tabs.Tab => { 253 | if (!tab) return null; 254 | 255 | if (this.detailsCache.has(tab)) { 256 | return this.detailsCache.get(tab); 257 | } 258 | 259 | return this.createDetails(tab); 260 | }; 261 | 262 | private getCurrent(e: Electron.IpcMainInvokeEvent) { 263 | const tab = this.getTabById(e.sender.id); 264 | if (!tab) return null; 265 | 266 | return this.getDetails(tab); 267 | } 268 | 269 | private async insertCSS( 270 | e: Electron.IpcMainEvent, 271 | extensionId: string, 272 | tabId: number, 273 | details: chrome.tabs.InjectDetails, 274 | ) { 275 | const tab = this.getTabById(tabId); 276 | if (!tab) return; 277 | 278 | if (details.hasOwnProperty('file')) { 279 | const ses = sessionFromIpcEvent(e); 280 | details.code = await promises.readFile( 281 | resolve(ses.getExtension(extensionId).path, details.file), 282 | 'utf8', 283 | ); 284 | } 285 | 286 | tab.insertCSS(details.code, { 287 | cssOrigin: details.cssOrigin, 288 | }); 289 | } 290 | 291 | private createDetails(tab: Tab): chrome.tabs.Tab { 292 | const window = getParentWindowOfTab(tab); 293 | const [width = 0, height = 0] = window ? window.getSize() : []; 294 | 295 | const prevDetails: Partial = this.detailsCache.get( 296 | tab, 297 | ) || { 298 | id: tab.id, 299 | active: false, 300 | highlighted: false, 301 | selected: false, 302 | autoDiscardable: true, 303 | discarded: false, 304 | incognito: false, 305 | index: 0, 306 | pinned: false, 307 | }; 308 | 309 | const details: chrome.tabs.Tab = { 310 | ...(prevDetails as chrome.tabs.Tab), 311 | audible: tab.isCurrentlyAudible(), 312 | favIconUrl: tab.favicon || undefined, 313 | height, 314 | width, 315 | mutedInfo: { muted: tab.audioMuted }, 316 | status: tab.isLoading() ? 'loading' : 'complete', 317 | title: tab.getTitle(), 318 | url: tab.getURL(), 319 | windowId: window ? window.id : -1, 320 | }; 321 | 322 | if (this.onCreateDetails) this.onCreateDetails(tab, details); 323 | 324 | this.detailsCache.set(tab, details); 325 | 326 | return details; 327 | } 328 | 329 | private onUpdated(tab: Tab) { 330 | if (!tab) return; 331 | 332 | const prevDetails: DetailsType = this.detailsCache.get(tab) as any; 333 | if (!prevDetails) return; 334 | 335 | const details: DetailsType = this.createDetails(tab) as any; 336 | 337 | const compareProps = [ 338 | 'status', 339 | 'url', 340 | 'pinned', 341 | 'audible', 342 | 'discarded', 343 | 'autoDiscardable', 344 | 'mutedInfo', 345 | 'favIconUrl', 346 | 'title', 347 | ]; 348 | 349 | let didUpdate = false; 350 | const changeInfo: any = {}; 351 | 352 | for (const prop of compareProps) { 353 | if (details[prop] !== prevDetails[prop]) { 354 | changeInfo[prop] = details[prop]; 355 | didUpdate = true; 356 | } 357 | } 358 | 359 | if (!didUpdate) return; 360 | 361 | this.emit('updated', tab.id, changeInfo, details); 362 | sendToExtensionPages('tabs.onUpdated', tab.id, changeInfo, details); 363 | } 364 | 365 | private onRemoved(tab: Tab) { 366 | const details = this.detailsCache.has(tab) 367 | ? this.detailsCache.get(tab) 368 | : null; 369 | 370 | this.detailsCache.delete(tab); 371 | 372 | const windowId = details ? details.windowId : -1; 373 | const win = Extensions.instance.windows.getWindowById(windowId); 374 | 375 | sendToExtensionPages('tabs.onRemoved', tab.id, { 376 | windowId, 377 | isWindowClosing: win ? win.isDestroyed() : false, 378 | }); 379 | } 380 | 381 | private onCreated(tab: Tab) { 382 | const details = this.getDetails(tab); 383 | sendToExtensionPages('tabs.onCreated', details); 384 | } 385 | } 386 | -------------------------------------------------------------------------------- /src/browser/web-navigation.ts: -------------------------------------------------------------------------------- 1 | import { sendToExtensionPages } from './background-pages'; 2 | 3 | export const hookWebNavigationEvents = (tab: Electron.WebContents) => { 4 | tab.on( 5 | 'did-start-navigation', 6 | (e, url, isInPlace, isMainFrame, frameProcessId, frameRoutingId) => { 7 | sendToExtensionPages('webNavigation.onCommitted', { 8 | frameId: isMainFrame ? 0 : frameRoutingId, 9 | parentFrameId: -1, 10 | processId: frameProcessId, 11 | tabId: tab.id, 12 | timeStamp: Date.now(), 13 | url, 14 | }); 15 | }, 16 | ); 17 | 18 | tab.on('will-navigate', (e, url) => { 19 | sendToExtensionPages('webNavigation.onBeforeNavigate', { 20 | frameId: 0, 21 | parentFrameId: -1, 22 | processId: -1, 23 | tabId: tab.id, 24 | timeStamp: Date.now(), 25 | url, 26 | }); 27 | }); 28 | 29 | tab.on('did-navigate', (e, url) => { 30 | sendToExtensionPages('webNavigation.onCompleted', { 31 | frameId: 0, 32 | parentFrameId: -1, 33 | processId: tab.getProcessId(), 34 | tabId: tab.id, 35 | timeStamp: Date.now(), 36 | url, 37 | }); 38 | }); 39 | 40 | tab.on( 41 | 'did-navigate-in-page', 42 | (e, url, isMainFrame, frameProcessId, frameRoutingId) => { 43 | sendToExtensionPages('webNavigation.onCompleted', { 44 | frameId: isMainFrame ? 0 : frameRoutingId, 45 | parentFrameId: -1, 46 | processId: frameProcessId, 47 | tabId: tab.id, 48 | timeStamp: Date.now(), 49 | url, 50 | }); 51 | }, 52 | ); 53 | 54 | tab.once('will-navigate', (e, url) => { 55 | sendToExtensionPages('webNavigation.onCreatedNavigationTarget', { 56 | sourceTabId: tab.id, 57 | sourceProcessId: tab.getProcessId(), 58 | sourceFrameId: 0, 59 | url, 60 | tabId: tab.id, 61 | timeStamp: Date.now(), 62 | }); 63 | }); 64 | }; 65 | -------------------------------------------------------------------------------- /src/browser/web-request-api.ts: -------------------------------------------------------------------------------- 1 | import { webContents, ipcMain } from 'electron'; 2 | import { sessionFromIpcEvent } from '../utils/session'; 3 | import { webContentsInvoke } from '../utils/web-contents'; 4 | import extendElectronWebRequest from '../utils/web-request'; 5 | 6 | const clearCacheOnNavigation = () => { 7 | webContents.getAllWebContents().forEach((wc) => { 8 | const onNavigation = true; 9 | // TODO(sentialx): receive clear-cache in renderer 10 | wc.send('clear-cache', onNavigation); 11 | }); 12 | }; 13 | 14 | const electronToChromeRequestType = (type: string): any => { 15 | if (type === 'mainFrame') return 'main_frame'; 16 | if (type === 'subFrame') return 'sub_frame'; 17 | if (type === 'cspReport') return 'csp_report'; 18 | return type; 19 | }; 20 | 21 | const chromeToElectronHeaders = (headers: any) => { 22 | const newHeaders: any = {}; 23 | headers.forEach((header: any) => (newHeaders[header.name] = [header.value])); 24 | return newHeaders; 25 | }; 26 | 27 | const electronToChromeDetails = (details: any) => { 28 | const newDetails = { 29 | ...details, 30 | requestId: details.id.toString(), 31 | frameId: 0, 32 | parentFrameId: -1, 33 | type: electronToChromeRequestType(details.resourceType), 34 | timeStamp: Date.now(), 35 | tabId: details.webContentsId, 36 | error: '', 37 | }; 38 | 39 | if (newDetails.responseHeaders) { 40 | newDetails.responseHeaders = Object.keys(newDetails.responseHeaders).map( 41 | (k) => ({ 42 | name: k, 43 | value: newDetails.responseHeaders[k][0], 44 | }), 45 | ); 46 | } 47 | 48 | return newDetails; 49 | }; 50 | 51 | export class WebRequestAPI { 52 | constructor() { 53 | // TODO(sentialx): send clear-cache from renderer 54 | ipcMain.on('clear-cache', () => { 55 | clearCacheOnNavigation(); 56 | }); 57 | 58 | ipcMain.on('webRequest.addListener', this.addListener); 59 | } 60 | 61 | private addListener = ( 62 | e: Electron.IpcMainEvent, 63 | listenerId: string, 64 | name: string, 65 | filter: any, 66 | ) => { 67 | const session = sessionFromIpcEvent(e); 68 | const { webRequest }: any = extendElectronWebRequest(session); 69 | 70 | // Ignore unknown webRequest event names. 71 | if (!Object.getOwnPropertyNames(webRequest.webRequest).includes(name)) 72 | return; 73 | 74 | clearCacheOnNavigation(); 75 | 76 | const { id }: any = webRequest.addListener( 77 | name, 78 | filter, 79 | async (details: any, callback: any) => { 80 | const returnedDetails = await webContentsInvoke( 81 | e.sender, 82 | listenerId, 83 | electronToChromeDetails(details), 84 | ); 85 | 86 | if (!returnedDetails) return callback(details); 87 | 88 | if (returnedDetails.responseHeaders) { 89 | returnedDetails.responseHeaders = chromeToElectronHeaders( 90 | returnedDetails.responseHeaders, 91 | ); 92 | } 93 | 94 | return callback(returnedDetails); 95 | }, 96 | ); 97 | 98 | ipcMain.on(`webRequest.removeListener-${listenerId}`, () => { 99 | webRequest.removeListener(name, id); 100 | }); 101 | }; 102 | } 103 | -------------------------------------------------------------------------------- /src/browser/web-request-electron.ts: -------------------------------------------------------------------------------- 1 | import { webContents } from 'electron'; 2 | import extendElectronWebRequest from '../utils/web-request'; 3 | import { PROTOCOL_SCHEME } from '../constants'; 4 | 5 | const requestIsOption = (details: any) => { 6 | const { method } = details; 7 | 8 | return method === 'OPTIONS'; 9 | }; 10 | 11 | const requestIsFromBackgroundPage = (details: any): boolean => { 12 | const { webContentsId } = details; 13 | 14 | if (webContentsId) { 15 | const wc = webContents.fromId(webContentsId); 16 | 17 | if (wc) { 18 | return wc.getURL().startsWith(PROTOCOL_SCHEME); 19 | } 20 | 21 | return false; 22 | } 23 | 24 | return false; 25 | }; 26 | 27 | const requestsOrigins = new Map(); 28 | 29 | const requestIsXhrOrSubframe = (details: any) => { 30 | const { resourceType } = details; 31 | 32 | const isXhr = resourceType === 'xhr'; 33 | const isSubframe = resourceType === 'subFrame'; 34 | 35 | return isXhr || isSubframe; 36 | }; 37 | 38 | const requestHasExtensionOrigin = (details: any) => { 39 | const { id } = details; 40 | 41 | const origin = requestsOrigins.get(id); 42 | 43 | if (origin) { 44 | return origin.startsWith(PROTOCOL_SCHEME); 45 | } 46 | 47 | return false; 48 | }; 49 | 50 | const requestIsForExtension = (details: any) => 51 | requestHasExtensionOrigin(details) && requestIsXhrOrSubframe(details); 52 | 53 | export const hookExtensionWebRequestBypass = (session: Electron.Session) => { 54 | extendElectronWebRequest(session); 55 | 56 | session.webRequest.onBeforeSendHeaders((details, callback) => { 57 | requestsOrigins.set(details.id, details.requestHeaders.Origin); 58 | 59 | if ( 60 | !requestIsFromBackgroundPage(details) && 61 | requestIsForExtension(details) && 62 | !requestIsOption(details) 63 | ) { 64 | return callback({ 65 | requestHeaders: { 66 | ...details.requestHeaders, 67 | Origin: null, 68 | }, 69 | }); 70 | } 71 | 72 | callback({ requestHeaders: details.requestHeaders }); 73 | }); 74 | 75 | session.webRequest.onHeadersReceived((details, callback) => { 76 | for (const key in details.responseHeaders) { 77 | const val = details.responseHeaders[key]; 78 | delete details.responseHeaders[key]; 79 | details.responseHeaders[key.toLowerCase()] = val; 80 | } 81 | 82 | const accessControlAllowOrigin = 83 | details.responseHeaders['access-control-allow-origin'] || []; 84 | const allowedOriginIsWildcard = accessControlAllowOrigin.includes('*'); 85 | 86 | details.responseHeaders['access-control-allow-credentials'] = ['true']; 87 | 88 | if (requestIsForExtension(details) || allowedOriginIsWildcard) { 89 | details.responseHeaders['access-control-allow-origin'] = [ 90 | requestsOrigins.get(details.id), 91 | ]; 92 | } 93 | 94 | requestsOrigins.delete(details.id); 95 | 96 | callback({ responseHeaders: details.responseHeaders }); 97 | }); 98 | }; 99 | -------------------------------------------------------------------------------- /src/browser/windows.ts: -------------------------------------------------------------------------------- 1 | import { BrowserWindow } from 'electron'; 2 | import { EventEmitter } from 'events'; 3 | import { Extensions } from '.'; 4 | import { isBackgroundPage } from '../utils/web-contents'; 5 | import { WINDOW_ID_CURRENT } from '../constants'; 6 | import { sendToExtensionPages } from './background-pages'; 7 | import { HandlerFactory } from './handler-factory'; 8 | 9 | // Events which can be registered only once 10 | interface IWindowsEvents { 11 | onCreateDetails: ( 12 | window: BrowserWindow, 13 | details: chrome.windows.Window, 14 | ) => void; 15 | onBeforeFocusNextZOrder: (windowId: number) => number; 16 | onCreate: (details: chrome.windows.CreateData) => Promise; 17 | } 18 | 19 | export declare interface WindowsAPI { 20 | on(event: 'focused', listener: (windowId: number) => void): this; 21 | on(event: 'created', listener: (window: chrome.windows.Window) => void): this; 22 | on(event: 'will-remove', listener: (windowId: number) => void): this; 23 | on(event: string, listener: Function): this; 24 | } 25 | 26 | export class WindowsAPI extends EventEmitter implements IWindowsEvents { 27 | private windows: Set = new Set(); 28 | 29 | private detailsCache: Map = new Map(); 30 | 31 | private lastFocused: BrowserWindow; 32 | 33 | constructor() { 34 | super(); 35 | 36 | const handler = HandlerFactory.create('windows', this); 37 | 38 | handler('create', this.create); 39 | handler('update', this.update); 40 | handler('getAll', this.getAll); 41 | handler('getLastFocused', this.getLastFocused); 42 | 43 | handler('get', this.getHandler, true); 44 | handler('getCurrent', this.getCurrent, true); 45 | } 46 | 47 | onBeforeFocusNextZOrder: (windowId: number) => number; 48 | onCreateDetails: ( 49 | window: BrowserWindow, 50 | details: chrome.windows.Window, 51 | ) => void; 52 | onCreate: (details: chrome.windows.CreateData) => Promise; 53 | 54 | public update(windowId: number, updateInfo: chrome.windows.UpdateInfo) { 55 | const win = this.getWindowById(windowId); 56 | if (!win) return null; 57 | 58 | const { left, top, width, height, state } = updateInfo; 59 | 60 | if (!['minimized', 'maximized', 'fullscreen'].includes(state)) { 61 | const bounds = win.getBounds(); 62 | const newBounds: Electron.Rectangle = { ...bounds }; 63 | 64 | if (!isNaN(left)) newBounds.x = Math.floor(left); 65 | if (!isNaN(top)) newBounds.y = Math.floor(top); 66 | if (!isNaN(width) && width > 0) newBounds.width = Math.floor(width); 67 | if (!isNaN(height) && height > 0) newBounds.height = Math.floor(height); 68 | 69 | if (bounds !== newBounds) { 70 | win.setBounds(newBounds); 71 | } 72 | } 73 | 74 | if (typeof updateInfo.drawAttention === 'boolean') { 75 | win.flashFrame(updateInfo.drawAttention && !win.isFocused()); 76 | } 77 | 78 | if (typeof updateInfo.focused === 'boolean') { 79 | if (updateInfo.focused) { 80 | if (state !== 'minimized') win.focus(); 81 | } else if ( 82 | this.onBeforeFocusNextZOrder && 83 | !['fullscreen', 'maximized'].includes(state) 84 | ) { 85 | const windowIdToFocus = this.onBeforeFocusNextZOrder(windowId); 86 | this.focus(windowIdToFocus); 87 | } 88 | } 89 | 90 | if (state === 'minimized') win.minimize(); 91 | else if (state === 'maximized') win.maximize(); 92 | else if (state === 'fullscreen') win.setFullScreen(true); 93 | else if (state === 'normal') { 94 | if (win.isFullScreen()) win.setFullScreen(false); 95 | if (win.isMinimized()) win.restore(); 96 | if (win.isMaximized()) win.unmaximize(); 97 | } 98 | 99 | return this.createDetails(win); 100 | } 101 | 102 | public focus(windowId: number) { 103 | const win = this.getWindowById(windowId); 104 | win.focus(); 105 | } 106 | 107 | public remove(windowId: number) { 108 | this.emit('will-remove', windowId); 109 | } 110 | 111 | public observe(window: BrowserWindow) { 112 | this.windows.add(window); 113 | 114 | window.once('closed', () => { 115 | this.windows.delete(window); 116 | this.onRemoved(window); 117 | }); 118 | 119 | window.on('focus', () => { 120 | this.lastFocused = window; 121 | }); 122 | 123 | this.onCreated(window); 124 | } 125 | 126 | public getWindowById(id: number) { 127 | return Array.from(this.windows).find((x) => x.id === id); 128 | } 129 | 130 | public async create( 131 | details: chrome.windows.CreateData, 132 | ): Promise { 133 | if (!this.onCreate) { 134 | throw new Error('No onCreate event handler'); 135 | } 136 | 137 | const id = await this.onCreate(details); 138 | const win = this.getWindowById(id); 139 | return this.getDetails(win); 140 | } 141 | 142 | public getLastFocused( 143 | getInfo: chrome.windows.GetInfo, 144 | ): chrome.windows.Window { 145 | return this.getDetailsMatchingGetInfo(this.lastFocused, getInfo); 146 | } 147 | 148 | public get( 149 | id: number, 150 | getInfo: chrome.windows.GetInfo, 151 | ): chrome.windows.Window { 152 | const win = this.getWindowById(id); 153 | return this.getDetailsMatchingGetInfo(win, getInfo); 154 | } 155 | 156 | public getAll(getInfo: chrome.windows.GetInfo): chrome.windows.Window[] { 157 | return Array.from(this.windows) 158 | .map((win) => this.getDetailsMatchingGetInfo(win, getInfo)) 159 | .filter(Boolean); 160 | } 161 | 162 | private getHandler( 163 | event: Electron.IpcMainInvokeEvent, 164 | id: number, 165 | details: any, 166 | ) { 167 | return id === WINDOW_ID_CURRENT 168 | ? this.getCurrent(event, details) 169 | : this.get(id, details); 170 | } 171 | 172 | private getCurrent = ( 173 | event: Electron.IpcMainInvokeEvent, 174 | getInfo: chrome.windows.GetInfo, 175 | ): chrome.windows.Window => { 176 | const tab = Extensions.instance.tabs.getTabById(event.sender.id); 177 | 178 | if (!tab) { 179 | if (isBackgroundPage(event.sender)) { 180 | return this.getDetailsMatchingGetInfo(this.lastFocused, getInfo); 181 | } 182 | return null; 183 | } 184 | 185 | const tabDetails = Extensions.instance.tabs.getDetails(tab); 186 | const win = this.getWindowById(tabDetails.windowId); 187 | 188 | return this.getDetailsMatchingGetInfo(win, getInfo); 189 | }; 190 | 191 | private createDetails(win: BrowserWindow): chrome.windows.Window { 192 | const { x, y, width, height } = win.getBounds(); 193 | 194 | let state = 'normal'; 195 | 196 | if (win.isFullScreen()) state = 'fullscreen'; 197 | else if (win.isMaximized()) state = 'maximized'; 198 | else if (win.isMinimized()) state = 'minimized'; 199 | 200 | const details: chrome.windows.Window = { 201 | id: win.id, 202 | focused: win.isFocused(), 203 | top: y, 204 | left: x, 205 | width, 206 | height, 207 | incognito: false, 208 | type: 'normal', 209 | state, 210 | alwaysOnTop: win.isAlwaysOnTop(), 211 | }; 212 | 213 | if (this.onCreateDetails) this.onCreateDetails(win, details); 214 | 215 | this.detailsCache.set(win, details); 216 | 217 | return details; 218 | } 219 | 220 | private getDetails(win: BrowserWindow): chrome.windows.Window { 221 | if (!win) return null; 222 | 223 | if (this.detailsCache.has(win)) { 224 | return this.detailsCache.get(win); 225 | } 226 | 227 | return this.createDetails(win); 228 | } 229 | 230 | private getDetailsMatchingGetInfo = ( 231 | win: BrowserWindow, 232 | getInfo: chrome.windows.GetInfo, 233 | ): chrome.windows.Window => { 234 | if (!win) return null; 235 | 236 | const details = this.getDetails(win); 237 | 238 | let windowTypes = getInfo?.windowTypes; 239 | 240 | if (!Array.isArray(windowTypes)) { 241 | windowTypes = ['normal', 'popup']; 242 | } 243 | 244 | if (!windowTypes.includes(details.type)) return null; 245 | 246 | if (getInfo?.populate === true) { 247 | return { 248 | ...details, 249 | tabs: Extensions.instance.tabs.query({ windowId: win.id }), 250 | }; 251 | } 252 | 253 | return details; 254 | }; 255 | 256 | private onRemoved(win: BrowserWindow) { 257 | this.emit('will-remove', win.id); 258 | sendToExtensionPages('windows.onRemoved', { 259 | windowId: win.id, 260 | }); 261 | } 262 | 263 | private onCreated(win: BrowserWindow) { 264 | const details = this.getDetails(win); 265 | this.emit('created', details); 266 | sendToExtensionPages('windows.onCreated', details); 267 | } 268 | } 269 | -------------------------------------------------------------------------------- /src/constants.ts: -------------------------------------------------------------------------------- 1 | export const WINDOW_ID_NONE = -1; 2 | export const WINDOW_ID_CURRENT = -2; 3 | 4 | export const TAB_ID_NONE = -1; 5 | 6 | export const PROTOCOL = 'chrome-extension'; 7 | export const PROTOCOL_SCHEME = `${PROTOCOL}://`; 8 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | export * from './browser'; 2 | -------------------------------------------------------------------------------- /src/interfaces/tabs.ts: -------------------------------------------------------------------------------- 1 | export interface Tab extends Electron.WebContents { 2 | favicon?: string; 3 | } 4 | -------------------------------------------------------------------------------- /src/models/ipc-event.ts: -------------------------------------------------------------------------------- 1 | import { ipcRenderer } from 'electron'; 2 | 3 | export class IpcEvent { 4 | private name: string; 5 | 6 | constructor(name: string) { 7 | this.name = name; 8 | } 9 | 10 | public addListener(callback: any) { 11 | ipcRenderer.addListener(this.name, (e, ...args) => { 12 | callback(...args); 13 | }); 14 | } 15 | 16 | public removeListener(callback: any) { 17 | ipcRenderer.removeListener(this.name, callback); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/models/web-request-event.ts: -------------------------------------------------------------------------------- 1 | import { ipcRenderer } from 'electron'; 2 | import { randomId } from '../utils/string'; 3 | 4 | export class WebRequestEvent { 5 | private name: string; 6 | 7 | private callbackIdMap: Map = new Map(); 8 | 9 | constructor(name: string) { 10 | this.name = name; 11 | } 12 | 13 | public addListener(callback: Function, filters: string[] = null) { 14 | const id = randomId(); 15 | this.callbackIdMap.set(callback, id); 16 | 17 | ipcRenderer.on(id, (e, details, responseId) => { 18 | const response = callback(details); 19 | 20 | ipcRenderer.send(`${id}-${responseId}`, response); 21 | }); 22 | 23 | ipcRenderer.send('webRequest.addListener', id, this.name, filters); 24 | } 25 | 26 | public removeListener(callback: Function) { 27 | if (!this.callbackIdMap.has(callback)) { 28 | return; 29 | } 30 | 31 | const id = this.callbackIdMap.get(callback); 32 | 33 | ipcRenderer.removeAllListeners(id); 34 | ipcRenderer.send(`webRequest.removeListener-${id}`); 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/renderer/api.ts: -------------------------------------------------------------------------------- 1 | import { IpcEvent } from '../models/ipc-event'; 2 | import { ipcInvoker } from './ipc-invoker'; 3 | import { WINDOW_ID_NONE, WINDOW_ID_CURRENT, TAB_ID_NONE } from '../constants'; 4 | import { WebRequestEvent } from '../models/web-request-event'; 5 | import { imageData2base64 } from '../utils/images'; 6 | 7 | declare const chrome: any; 8 | 9 | class PolicyConfig { 10 | get() {} 11 | set() {} 12 | clear() {} 13 | } 14 | 15 | export const injectAPI = () => { 16 | const manifest = chrome.runtime.getManifest(); 17 | 18 | const tabs = { 19 | ...chrome.tabs, 20 | TAB_ID_NONE, 21 | getCurrent: ipcInvoker('tabs.getCurrent'), 22 | create: ipcInvoker('tabs.create'), 23 | get: ipcInvoker('tabs.get'), 24 | remove: ipcInvoker('tabs.remove'), 25 | getAllInWindow: ipcInvoker('tabs.getAllInWindow'), 26 | getSelected: ipcInvoker('tabs.getSelected'), 27 | insertCSS: ipcInvoker('tabs.insertCSS'), 28 | query: ipcInvoker('tabs.query'), 29 | reload: ipcInvoker('tabs.reload'), 30 | update: ipcInvoker('tabs.update'), 31 | onCreated: new IpcEvent('tabs.onCreated'), 32 | onRemoved: new IpcEvent('tabs.onRemoved'), 33 | onUpdated: new IpcEvent('tabs.onUpdated'), 34 | onActivated: new IpcEvent('tabs.onActivated'), 35 | }; 36 | 37 | const cookies = { 38 | ...chrome.cookies, 39 | get: ipcInvoker('cookies.get'), 40 | getAll: ipcInvoker('cookies.getAll'), 41 | remove: ipcInvoker('cookies.remove'), 42 | set: ipcInvoker('cookies.set'), 43 | onChanged: new IpcEvent('cookies.onChanged'), 44 | }; 45 | 46 | const windows = { 47 | ...chrome.windows, 48 | WINDOW_ID_NONE, 49 | WINDOW_ID_CURRENT, 50 | get: ipcInvoker('windows.get'), 51 | getAll: ipcInvoker('windows.getAll'), 52 | getCurrent: ipcInvoker('windows.getCurrent'), 53 | getLastFocused: ipcInvoker('windows.getLastFocused'), 54 | create: ipcInvoker('windows.create'), 55 | update: ipcInvoker('windows.update'), 56 | remove: ipcInvoker('windows.remove'), 57 | onCreated: new IpcEvent('windows.onCreated'), 58 | onRemoved: new IpcEvent('windows.onRemoved'), 59 | onFocusChanged: new IpcEvent('windows.onFocusChanged'), 60 | }; 61 | 62 | const extension = { 63 | ...chrome.extension, 64 | getViews: (): any[] => [], 65 | isAllowedFileSchemeAccess: (cb: any) => cb && cb(false), 66 | isAllowedIncognitoAccess: (cb: any) => cb && cb(false), 67 | }; 68 | 69 | const contextMenus = { 70 | ...chrome.contextMenus, 71 | onClicked: new IpcEvent('contextMenus.onClicked'), 72 | create: ipcInvoker('contextMenus.create', { noop: true }), 73 | removeAll: ipcInvoker('contextMenus.removeAll', { noop: true }), 74 | remove: ipcInvoker('contextMenus.remove', { noop: true }), 75 | }; 76 | 77 | const notifications = { 78 | ...chrome.notifications, 79 | create() {}, 80 | update() {}, 81 | clear() {}, 82 | getAll() {}, 83 | getPermissionLevel() {}, 84 | onClosed: new IpcEvent('notifications.onClosed'), 85 | onClicked: new IpcEvent('notifications.onClicked'), 86 | onButtonClicked: new IpcEvent('notifications.onButtonClicked'), 87 | onPermissionLevelChanged: new IpcEvent( 88 | 'notifications.onPermissionLevelChanged', 89 | ), 90 | onShowSettings: new IpcEvent('notifications.onShowSettings'), 91 | }; 92 | 93 | const permissions = { 94 | ...chrome.permissions, 95 | onAdded: new IpcEvent('permissions.onAdded'), 96 | getAll: () => {}, 97 | }; 98 | 99 | const privacy = { 100 | ...chrome.privacy, 101 | network: { 102 | networkPredictionEnabled: new PolicyConfig(), 103 | webRTCIPHandlingPolicy: new PolicyConfig(), 104 | webRTCMultipleRoutesEnabled: new PolicyConfig(), 105 | webRTCNonProxiedUdpEnabled: new PolicyConfig(), 106 | }, 107 | websites: { 108 | hyperlinkAuditingEnabled: new PolicyConfig(), 109 | }, 110 | }; 111 | 112 | const browserAction = { 113 | ...chrome.browserAction, 114 | setBadgeBackgroundColor: ipcInvoker( 115 | 'browserAction.setBadgeBackgroundColor', 116 | { 117 | includeId: true, 118 | }, 119 | ), 120 | setBadgeText: ipcInvoker('browserAction.setBadgeText', { 121 | includeId: true, 122 | }), 123 | setIcon: ipcInvoker('browserAction.setIcon', { 124 | includeId: true, 125 | serialize: (details: any) => { 126 | if (details.imageData) { 127 | if (details.imageData instanceof ImageData) { 128 | details.imageData = imageData2base64(details.imageData); 129 | } else { 130 | details.imageData = Object.entries(details.imageData).reduce( 131 | (obj: any, pair: any) => { 132 | obj[pair[0]] = imageData2base64(pair[1]); 133 | return obj; 134 | }, 135 | {}, 136 | ); 137 | } 138 | } 139 | 140 | return [details]; 141 | }, 142 | }), 143 | setTitle: ipcInvoker('browserAction.setTitle', { 144 | includeId: true, 145 | }), 146 | setPopup: ipcInvoker('browserAction.setPopup', { 147 | includeId: true, 148 | }), 149 | onClicked: new IpcEvent('browserAction.onClicked'), 150 | }; 151 | 152 | const webRequest = { 153 | ...chrome.webRequest, 154 | ResourceType: { 155 | CSP_REPORT: 'csp_report', 156 | FONT: 'font', 157 | IMAGE: 'image', 158 | MAIN_FRAME: 'main_frame', 159 | MEDIA: 'media', 160 | OBJECT: 'object', 161 | OTHER: 'other', 162 | PING: 'ping', 163 | SCRIPT: 'script', 164 | STYLESHEET: 'stylesheet', 165 | SUB_FRAME: 'sub_frame', 166 | WEBSOCKET: 'websocket', 167 | XMLHTTPREQUEST: 'xmlhttprequest', 168 | }, 169 | 170 | onBeforeRequest: new WebRequestEvent('onBeforeRequest'), 171 | onBeforeSendHeaders: new WebRequestEvent('onBeforeSendHeaders'), 172 | onHeadersReceived: new WebRequestEvent('onHeadersReceived'), 173 | onSendHeaders: new WebRequestEvent('onSendHeaders'), 174 | onResponseStarted: new WebRequestEvent('onResponseStarted'), 175 | onBeforeRedirect: new WebRequestEvent('onBeforeRedirect'), 176 | onCompleted: new WebRequestEvent('onCompleted'), 177 | onErrorOccurred: new WebRequestEvent('onErrorOccurred'), 178 | onAuthRequired: new WebRequestEvent('onAuthRequired'), 179 | }; 180 | 181 | const webNavigation = { 182 | ...chrome.webNavigation, 183 | onBeforeNavigate: new IpcEvent('webNavigation.onBeforeNavigate'), 184 | onCompleted: new IpcEvent('webNavigation.onCompleted'), 185 | onCreatedNavigationTarget: new IpcEvent( 186 | 'webNavigation.onCreatedNavigationTarget', 187 | ), 188 | onCommitted: new IpcEvent('webNavigation.onCommitted'), 189 | }; 190 | 191 | Object.assign(chrome, { 192 | tabs, 193 | cookies, 194 | windows, 195 | extension, 196 | notifications, 197 | permissions, 198 | contextMenus, 199 | webNavigation, 200 | webRequest, 201 | privacy, 202 | }); 203 | 204 | if (manifest.browser_action) { 205 | chrome.browserAction = browserAction; 206 | } 207 | 208 | if (chrome.storage) { 209 | chrome.storage.sync = chrome.storage.local; 210 | } 211 | 212 | Object.freeze(chrome); 213 | }; 214 | -------------------------------------------------------------------------------- /src/renderer/index.ts: -------------------------------------------------------------------------------- 1 | import { injectAPI } from './api'; 2 | import { PROTOCOL_SCHEME } from '../constants'; 3 | 4 | (async () => { 5 | if (!location.href.startsWith(PROTOCOL_SCHEME)) return; 6 | (process as any).once('document-start', () => { 7 | injectAPI(); 8 | }); 9 | })(); 10 | -------------------------------------------------------------------------------- /src/renderer/ipc-invoker.ts: -------------------------------------------------------------------------------- 1 | import { ipcRenderer } from 'electron'; 2 | 3 | const extensionId = chrome?.runtime?.id; 4 | 5 | interface IInvokeOptions { 6 | noop?: boolean; 7 | noopValue?: any; 8 | includeId?: boolean; 9 | serialize?: (...args: any[]) => any[]; 10 | } 11 | 12 | export const ipcInvoker = ( 13 | name: string, 14 | { noop, noopValue, includeId, serialize }: IInvokeOptions = {}, 15 | ) => async (...args: any[]) => { 16 | const callback = 17 | typeof args[args.length - 1] === 'function' ? args.pop() : undefined; 18 | 19 | if (noop || typeof noopValue !== 'undefined') { 20 | if (callback) callback(noopValue); 21 | return noopValue; 22 | } 23 | 24 | if (serialize) { 25 | args = serialize(...args); 26 | } 27 | 28 | if (includeId) { 29 | args = [extensionId, ...args]; 30 | } 31 | 32 | const result = await ipcRenderer.invoke(name, ...args); 33 | 34 | if (callback) { 35 | callback(result); 36 | } else { 37 | return result; 38 | } 39 | }; 40 | -------------------------------------------------------------------------------- /src/utils/images.ts: -------------------------------------------------------------------------------- 1 | export const imageData2base64 = (imageData: ImageData) => { 2 | const canvas = document.createElement('canvas'); 3 | const ctx = canvas.getContext('2d'); 4 | canvas.width = imageData.width; 5 | canvas.height = imageData.height; 6 | ctx.putImageData(imageData, 0, 0); 7 | 8 | return canvas.toDataURL(); 9 | }; 10 | -------------------------------------------------------------------------------- /src/utils/session.ts: -------------------------------------------------------------------------------- 1 | import { session } from 'electron'; 2 | 3 | let fallbackSession: Electron.Session; 4 | 5 | export const _setFallbackSession = (ses: Electron.Session) => { 6 | fallbackSession = ses; 7 | }; 8 | 9 | export const sessionFromIpcEvent = (e: Electron.IpcMainEvent) => 10 | e.sender.session || fallbackSession || session.defaultSession; 11 | -------------------------------------------------------------------------------- /src/utils/string.ts: -------------------------------------------------------------------------------- 1 | import { v4 as uuidv4 } from 'uuid'; 2 | 3 | export const randomId = () => uuidv4(); 4 | -------------------------------------------------------------------------------- /src/utils/url.ts: -------------------------------------------------------------------------------- 1 | export const matchesPattern = (pattern: string, url: string) => { 2 | if (pattern === '') { 3 | return true; 4 | } 5 | 6 | const regexp = new RegExp( 7 | `^${pattern.replace(/\*/g, '.*').replace('/', '\\/')}$`, 8 | ); 9 | return url.match(regexp) != null; 10 | }; 11 | -------------------------------------------------------------------------------- /src/utils/web-contents.ts: -------------------------------------------------------------------------------- 1 | import { PROTOCOL_SCHEME } from '../constants'; 2 | import { randomId } from './string'; 3 | import { ipcMain } from 'electron'; 4 | 5 | // TODO: https://github.com/electron/electron/pull/22217 6 | export const isBackgroundPage = (wc: Electron.WebContents) => 7 | // TODO: wc.getType() === 'backgroundPage'; 8 | wc.getType() === 'remote' && wc.getURL().startsWith(PROTOCOL_SCHEME); 9 | 10 | export const webContentsInvoke = ( 11 | wc: Electron.WebContents, 12 | channel: string, 13 | ...args: any[] 14 | ): Promise => 15 | new Promise((resolve) => { 16 | const id = randomId(); 17 | 18 | ipcMain.once(`${channel}-${id}`, (e: any, ...a: any[]) => resolve(...a)); 19 | 20 | wc.send(channel, ...args, id); 21 | }); 22 | -------------------------------------------------------------------------------- /src/utils/web-request.ts: -------------------------------------------------------------------------------- 1 | import { Session } from 'electron'; 2 | 3 | import { matchesPattern } from './url'; 4 | import { randomId } from './string'; 5 | 6 | type WebRequestWithCallback = 7 | | 'onBeforeRequest' 8 | | 'onBeforeSendHeaders' 9 | | 'onHeadersReceived'; 10 | 11 | type WebRequestWithoutCallback = 12 | | 'onSendHeaders' 13 | | 'onResponseStarted' 14 | | 'onBeforeRedirect' 15 | | 'onCompleted' 16 | | 'onErrorOccurred'; 17 | 18 | export type WebRequestMethod = 19 | | WebRequestWithCallback 20 | | WebRequestWithoutCallback; 21 | export type URLPattern = string; 22 | 23 | export interface IFilter { 24 | urls: string[]; 25 | } 26 | 27 | export interface IListener { 28 | id: string; 29 | urls: string[]; 30 | action: Function; 31 | context: IContext; 32 | } 33 | 34 | export interface IContext { 35 | priority?: number; 36 | origin?: string; 37 | order: number; 38 | } 39 | 40 | export interface IApplier { 41 | apply: Function; 42 | context: IContext; 43 | } 44 | 45 | export interface IAliasParameters { 46 | unbind: boolean; 47 | filter: IFilter; 48 | action: Function | null; 49 | context: Record; 50 | } 51 | 52 | export type IListenerCollection = Map; 53 | 54 | const defaultResolver = (listeners: IApplier[]) => { 55 | const response = listeners 56 | .sort((a, b) => b.context.order - a.context.order) 57 | .reduce( 58 | async (accumulator: any, element: any) => { 59 | if (accumulator.cancel) { 60 | return accumulator; 61 | } 62 | 63 | const result = await element.apply(); 64 | 65 | return { ...accumulator, ...result }; 66 | }, 67 | { cancel: false }, 68 | ); 69 | 70 | return response; 71 | }; 72 | 73 | const methodsWithCallback = [ 74 | 'onBeforeRequest', 75 | 'onBeforeSendHeaders', 76 | 'onHeadersReceived', 77 | ]; 78 | 79 | const aliasMethods = [ 80 | 'onBeforeRequest', 81 | 'onBeforeSendHeaders', 82 | 'onHeadersReceived', 83 | 'onSendHeaders', 84 | 'onResponseStarted', 85 | 'onBeforeRedirect', 86 | 'onCompleted', 87 | 'onErrorOccurred', 88 | ]; 89 | 90 | export class BetterWebRequest { 91 | public webRequest: any; 92 | 93 | private orderIndex: number; 94 | private listeners: Map; 95 | private filters: Map>; 96 | private resolvers: Map; 97 | 98 | constructor(webRequest: any) { 99 | this.orderIndex = 0; 100 | this.webRequest = webRequest; 101 | this.listeners = new Map(); 102 | this.filters = new Map(); 103 | this.resolvers = new Map(); 104 | } 105 | 106 | private get nextIndex() { 107 | return (this.orderIndex += 1); 108 | } 109 | 110 | getListeners() { 111 | return this.listeners; 112 | } 113 | 114 | getListenersFor(method: WebRequestMethod) { 115 | return this.listeners.get(method); 116 | } 117 | 118 | getFilters() { 119 | return this.filters; 120 | } 121 | 122 | getFiltersFor(method: WebRequestMethod) { 123 | return this.filters.get(method); 124 | } 125 | 126 | hasCallback(method: WebRequestMethod): boolean { 127 | return methodsWithCallback.includes(method); 128 | } 129 | 130 | alias(method: WebRequestMethod, parameters: any) { 131 | const args = this.parseArguments(parameters); 132 | return this.identifyAction(method, args); 133 | } 134 | 135 | addListener( 136 | method: WebRequestMethod, 137 | filter: IFilter, 138 | action: Function, 139 | outerContext: Partial = {}, 140 | ) { 141 | const { urls } = filter; 142 | const id = randomId(); 143 | const innerContext = { order: this.nextIndex }; 144 | const context = { ...outerContext, ...innerContext }; 145 | const listener = { 146 | id, 147 | urls, 148 | action, 149 | context, 150 | }; 151 | 152 | if (!this.listeners.has(method)) { 153 | this.listeners.set(method, new Map()); 154 | } 155 | 156 | this.listeners.get(method)!.set(id, listener); 157 | 158 | if (!this.filters.has(method)) { 159 | this.filters.set(method, new Set()); 160 | } 161 | 162 | const currentFilters = this.filters.get(method)!; 163 | for (const url of urls) { 164 | currentFilters.add(url); 165 | } 166 | 167 | this.webRequest[method]( 168 | { urls: [...currentFilters] }, 169 | this.listenerFactory(method), 170 | ); 171 | 172 | return listener; 173 | } 174 | 175 | removeListener(method: WebRequestMethod, id: IListener['id']) { 176 | const listeners = this.listeners.get(method); 177 | 178 | if (!listeners || !listeners.has(id)) { 179 | return; 180 | } 181 | 182 | if (listeners.size === 1) { 183 | this.clearListeners(method); 184 | } else { 185 | listeners.delete(id); 186 | 187 | const newFilters = this.mergeFilters(listeners); 188 | this.filters.set(method, newFilters); 189 | 190 | this.webRequest[method]( 191 | { urls: [...newFilters] }, 192 | this.listenerFactory(method), 193 | ); 194 | } 195 | } 196 | 197 | clearListeners(method: WebRequestMethod) { 198 | const listeners = this.listeners.get(method); 199 | const filters = this.filters.get(method); 200 | 201 | if (listeners) listeners.clear(); 202 | if (filters) filters.clear(); 203 | 204 | this.webRequest[method](null); 205 | } 206 | 207 | setResolver(method: WebRequestMethod, resolver: Function) { 208 | if (!this.hasCallback(method)) { 209 | console.warn( 210 | `Event method "${method}" has no callback and does not use a resolver`, 211 | ); 212 | return; 213 | } 214 | 215 | this.resolvers.set(method, resolver); 216 | } 217 | 218 | matchListeners(url: string, listeners: IListenerCollection): IListener[] { 219 | const arrayListeners = Array.from(listeners.values()); 220 | 221 | return arrayListeners.filter((element) => 222 | element.urls.some((value) => matchesPattern(value, url)), 223 | ); 224 | } 225 | 226 | private listenerFactory(method: WebRequestMethod) { 227 | return async (details: any, callback?: Function) => { 228 | if (!this.listeners.has(method)) { 229 | this.webRequest[method](null); 230 | return; 231 | } 232 | 233 | const listeners = this.listeners.get(method); 234 | 235 | if (!listeners) { 236 | if (callback) callback({ cancel: false }); 237 | return; 238 | } 239 | 240 | const matchedListeners = this.matchListeners(details.url, listeners); 241 | 242 | if (matchedListeners.length === 0) { 243 | if (callback) callback({ cancel: false }); 244 | return; 245 | } 246 | 247 | let resolve = this.resolvers.get(method); 248 | 249 | if (!resolve) { 250 | resolve = defaultResolver; 251 | } 252 | 253 | const requestsProcesses = this.processRequests(details, matchedListeners); 254 | 255 | if (this.hasCallback(method) && callback) { 256 | const modified = await resolve(requestsProcesses); 257 | callback(modified); 258 | } else { 259 | requestsProcesses.map((listener) => listener.apply()); 260 | } 261 | }; 262 | } 263 | 264 | private processRequests( 265 | details: any, 266 | requestListeners: IListener[], 267 | ): IApplier[] { 268 | const appliers: IApplier[] = []; 269 | 270 | for (const listener of requestListeners) { 271 | const apply = this.makeApplier(details, listener.action); 272 | 273 | appliers.push({ 274 | apply, 275 | context: listener.context, 276 | }); 277 | } 278 | 279 | return appliers; 280 | } 281 | 282 | private makeApplier(details: any, listener: Function): Function { 283 | return () => 284 | new Promise((resolve, reject) => { 285 | try { 286 | listener(details, resolve); 287 | } catch (err) { 288 | reject(err); 289 | } 290 | }); 291 | } 292 | 293 | private mergeFilters(listeners: IListenerCollection): Set { 294 | const arrayListeners = Array.from(listeners.values()); 295 | 296 | return arrayListeners.reduce((accumulator, value) => { 297 | for (const url of value.urls) accumulator.add(url); 298 | return accumulator; 299 | }, new Set()); 300 | } 301 | 302 | private parseArguments(parameters: any): IAliasParameters { 303 | const args = { 304 | unbind: false, 305 | filter: { urls: [''] }, 306 | action: null as any, 307 | context: {}, 308 | }; 309 | 310 | switch (parameters.length) { 311 | case 0: 312 | args.unbind = true; 313 | break; 314 | 315 | case 1: 316 | if (typeof parameters[0] === 'function') { 317 | args.action = parameters[0]; 318 | break; 319 | } 320 | 321 | throw new Error( 322 | 'Wrong function signature : No function listener given', 323 | ); 324 | 325 | case 2: 326 | if ( 327 | typeof parameters[0] === 'object' && 328 | typeof parameters[1] === 'function' 329 | ) { 330 | args.filter = parameters[0]; 331 | args.action = parameters[1]; 332 | break; 333 | } 334 | 335 | if (typeof parameters[0] === 'function') { 336 | args.action = parameters[0]; 337 | args.context = parameters[1]; 338 | break; 339 | } 340 | 341 | throw new Error( 342 | 'Wrong function signature : argument 1 should be an object filters or the function listener', 343 | ); 344 | 345 | case 3: 346 | if ( 347 | typeof parameters[0] === 'object' && 348 | typeof parameters[1] === 'function' 349 | ) { 350 | args.filter = parameters[0]; 351 | args.action = parameters[1]; 352 | args.context = parameters[2]; 353 | break; 354 | } 355 | 356 | throw new Error( 357 | 'Wrong function signature : should be arg 1 -> filter object, arg 2 -> function listener, arg 3 -> context', 358 | ); 359 | 360 | default: 361 | throw new Error('Wrong function signature : Too many arguments'); 362 | } 363 | 364 | return args; 365 | } 366 | 367 | private identifyAction(method: WebRequestMethod, args: IAliasParameters) { 368 | const { unbind, filter, action, context } = args; 369 | 370 | if (unbind) { 371 | return this.clearListeners(method); 372 | } 373 | 374 | if (!action) { 375 | throw new Error(`Cannot bind with ${method} : a listener is missing.`); 376 | } 377 | 378 | return this.addListener(method, filter, action, context); 379 | } 380 | } 381 | 382 | const aliasHandler = { 383 | get: (target: BetterWebRequest, property: any) => { 384 | if (aliasMethods.includes(property)) { 385 | return (...parameters: any) => { 386 | target.alias(property, parameters); 387 | }; 388 | } 389 | 390 | return (target as any)[property]; 391 | }, 392 | }; 393 | 394 | const betterWebRequest = (session: Session) => { 395 | return new Proxy(new BetterWebRequest(session.webRequest), aliasHandler); 396 | }; 397 | 398 | const store = new Set(); 399 | 400 | const extendElectronWebRequest = (session: Session): Session => { 401 | if (store.has(session)) { 402 | return session; 403 | } 404 | 405 | Object.defineProperty(session, 'webRequest', { 406 | value: betterWebRequest(session), 407 | writable: false, 408 | }); 409 | 410 | store.add(session); 411 | 412 | return session; 413 | }; 414 | 415 | export default extendElectronWebRequest; 416 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "outDir": "./build/", 4 | "noImplicitAny": true, 5 | "noImplicitReturns": true, 6 | "noImplicitThis": true, 7 | "alwaysStrict": true, 8 | "skipLibCheck": true, 9 | "declaration": true, 10 | "module": "commonjs", 11 | "target": "es2017", 12 | "sourceMap": true, 13 | "moduleResolution": "node", 14 | "allowSyntheticDefaultImports": true, 15 | "lib": ["esnext", "dom"], 16 | "experimentalDecorators": true 17 | }, 18 | "include": ["./src/**/*.ts"] 19 | } 20 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | /* eslint-disable */ 2 | const { resolve, join } = require('path'); 3 | const merge = require('webpack-merge'); 4 | /* eslint-enable */ 5 | 6 | const INCLUDE = resolve(__dirname, 'src'); 7 | 8 | const dev = process.env.ENV === 'dev'; 9 | 10 | const config = { 11 | mode: dev ? 'development' : 'production', 12 | 13 | devtool: dev ? 'inline-source-map' : 'source-map', 14 | 15 | output: { 16 | path: resolve(__dirname, 'build'), 17 | filename: '[name].js', 18 | libraryTarget: 'commonjs2', 19 | }, 20 | 21 | module: { 22 | rules: [ 23 | { 24 | test: /\.ts$/, 25 | use: [ 26 | { 27 | loader: 'ts-loader', 28 | }, 29 | ], 30 | 31 | include: INCLUDE, 32 | }, 33 | ], 34 | }, 35 | 36 | node: { 37 | __dirname: false, 38 | __filename: false, 39 | }, 40 | 41 | resolve: { 42 | modules: ['node_modules'], 43 | extensions: ['.js', '.ts', '.json'], 44 | alias: { 45 | '~': INCLUDE, 46 | }, 47 | }, 48 | }; 49 | 50 | function getConfig(...cfg) { 51 | return merge(config, ...cfg); 52 | } 53 | 54 | const mainConfig = getConfig({ 55 | target: 'electron-main', 56 | 57 | watch: dev, 58 | 59 | entry: { 60 | index: './src', 61 | }, 62 | 63 | plugins: [], 64 | }); 65 | 66 | const preloadsConfig = getConfig({ 67 | target: 'electron-renderer', 68 | 69 | watch: dev, 70 | 71 | entry: { 72 | preload: './src/renderer', 73 | }, 74 | 75 | plugins: [], 76 | 77 | output: { 78 | libraryTarget: 'var', 79 | }, 80 | }); 81 | 82 | module.exports = [mainConfig, preloadsConfig]; 83 | --------------------------------------------------------------------------------