From f35a7b0e70032de2feec9f3bda09da44cf0e1073 Mon Sep 17 00:00:00 2001 From: srv Date: Mon, 28 Apr 2025 17:11:28 -0500 Subject: first commit --- plugins/another_read_more_link/.gitignore | 89 +++ plugins/another_read_more_link/LICENSE | 201 ++++++ plugins/another_read_more_link/Readme.md | 33 + plugins/another_read_more_link/__init__.py | 1 + .../another_read_more_link.py | 72 +++ plugins/compressor/LICENSE | 661 ++++++++++++++++++++ plugins/compressor/README.md | 10 + plugins/compressor/__init__.py | 2 + plugins/compressor/compressor.py | 40 ++ plugins/compressor/css_minifer.py | 316 ++++++++++ plugins/compressor/js_minifer.py | 171 ++++++ plugins/compressor/minify.py | 266 ++++++++ plugins/compressor/variables.py | 211 +++++++ plugins/get_app_version/LICENSE | 674 +++++++++++++++++++++ plugins/get_app_version/README.md | 24 + plugins/get_app_version/__init__.py | 1 + plugins/get_app_version/get_app_version.py | 41 ++ plugins/i18n_subsites/README.rst | 165 +++++ plugins/i18n_subsites/__init__.py | 1 + plugins/i18n_subsites/i18n_subsites.py | 469 ++++++++++++++ .../implementing_language_buttons.rst | 128 ++++ plugins/i18n_subsites/localizing_using_jinja2.rst | 200 ++++++ .../i18n_subsites/test_data/content/images/img.png | 0 .../test_data/content/pages/hidden-page-cz.rst | 7 + .../test_data/content/pages/hidden-page-de.rst | 7 + .../test_data/content/pages/hidden-page-en.rst | 7 + .../test_data/content/pages/untranslated-page.rst | 5 + .../test_data/content/translated_article-cz.rst | 8 + .../test_data/content/translated_article-de.rst | 8 + .../test_data/content/translated_article-en.rst | 8 + .../test_data/content/untranslated_article-en.rst | 9 + .../test_data/localized_theme/babel.cfg | 2 + .../test_data/localized_theme/messages.pot | 23 + .../test_data/localized_theme/static/style.css | 0 .../test_data/localized_theme/templates/base.html | 7 + .../translations/de/LC_MESSAGES/messages.po | 23 + plugins/i18n_subsites/test_data/pelicanconf.py | 53 ++ plugins/i18n_subsites/test_i18n_subsites.py | 139 +++++ plugins/neighbors/LICENSE | 674 +++++++++++++++++++++ plugins/neighbors/Readme.rst | 97 +++ plugins/neighbors/__init__.py | 1 + plugins/neighbors/neighbors.py | 59 ++ plugins/pelican-css-js/LICENSE | 674 +++++++++++++++++++++ plugins/pelican-css-js/README.md | 87 +++ plugins/pelican-css-js/__init__.py | 1 + plugins/pelican-css-js/pelican_css_js.py | 87 +++ plugins/sitemap/LICENSE | 661 ++++++++++++++++++++ plugins/sitemap/README.md | 3 + plugins/sitemap/__init__.py | 1 + plugins/sitemap/sitemap.py | 271 +++++++++ plugins/tag-cloud/LICENSE | 661 ++++++++++++++++++++ plugins/tag-cloud/README.md | 3 + plugins/tag-cloud/__init__.py | 1 + plugins/tag-cloud/tag_cloud.py | 89 +++ plugins/tipue-search/LICENSE | 661 ++++++++++++++++++++ plugins/tipue-search/README.md | 98 +++ plugins/tipue-search/__init__.py | 1 + plugins/tipue-search/tipue_search.py | 212 +++++++ 58 files changed, 8424 insertions(+) create mode 100644 plugins/another_read_more_link/.gitignore create mode 100644 plugins/another_read_more_link/LICENSE create mode 100644 plugins/another_read_more_link/Readme.md create mode 100644 plugins/another_read_more_link/__init__.py create mode 100644 plugins/another_read_more_link/another_read_more_link.py create mode 100644 plugins/compressor/LICENSE create mode 100644 plugins/compressor/README.md create mode 100644 plugins/compressor/__init__.py create mode 100644 plugins/compressor/compressor.py create mode 100644 plugins/compressor/css_minifer.py create mode 100644 plugins/compressor/js_minifer.py create mode 100644 plugins/compressor/minify.py create mode 100644 plugins/compressor/variables.py create mode 100644 plugins/get_app_version/LICENSE create mode 100644 plugins/get_app_version/README.md create mode 100644 plugins/get_app_version/__init__.py create mode 100644 plugins/get_app_version/get_app_version.py create mode 100644 plugins/i18n_subsites/README.rst create mode 100644 plugins/i18n_subsites/__init__.py create mode 100644 plugins/i18n_subsites/i18n_subsites.py create mode 100644 plugins/i18n_subsites/implementing_language_buttons.rst create mode 100644 plugins/i18n_subsites/localizing_using_jinja2.rst create mode 100644 plugins/i18n_subsites/test_data/content/images/img.png create mode 100644 plugins/i18n_subsites/test_data/content/pages/hidden-page-cz.rst create mode 100644 plugins/i18n_subsites/test_data/content/pages/hidden-page-de.rst create mode 100644 plugins/i18n_subsites/test_data/content/pages/hidden-page-en.rst create mode 100644 plugins/i18n_subsites/test_data/content/pages/untranslated-page.rst create mode 100644 plugins/i18n_subsites/test_data/content/translated_article-cz.rst create mode 100644 plugins/i18n_subsites/test_data/content/translated_article-de.rst create mode 100644 plugins/i18n_subsites/test_data/content/translated_article-en.rst create mode 100644 plugins/i18n_subsites/test_data/content/untranslated_article-en.rst create mode 100644 plugins/i18n_subsites/test_data/localized_theme/babel.cfg create mode 100644 plugins/i18n_subsites/test_data/localized_theme/messages.pot create mode 100644 plugins/i18n_subsites/test_data/localized_theme/static/style.css create mode 100644 plugins/i18n_subsites/test_data/localized_theme/templates/base.html create mode 100644 plugins/i18n_subsites/test_data/localized_theme/translations/de/LC_MESSAGES/messages.po create mode 100644 plugins/i18n_subsites/test_data/pelicanconf.py create mode 100644 plugins/i18n_subsites/test_i18n_subsites.py create mode 100644 plugins/neighbors/LICENSE create mode 100644 plugins/neighbors/Readme.rst create mode 100644 plugins/neighbors/__init__.py create mode 100644 plugins/neighbors/neighbors.py create mode 100644 plugins/pelican-css-js/LICENSE create mode 100644 plugins/pelican-css-js/README.md create mode 100644 plugins/pelican-css-js/__init__.py create mode 100644 plugins/pelican-css-js/pelican_css_js.py create mode 100644 plugins/sitemap/LICENSE create mode 100644 plugins/sitemap/README.md create mode 100644 plugins/sitemap/__init__.py create mode 100644 plugins/sitemap/sitemap.py create mode 100644 plugins/tag-cloud/LICENSE create mode 100644 plugins/tag-cloud/README.md create mode 100644 plugins/tag-cloud/__init__.py create mode 100644 plugins/tag-cloud/tag_cloud.py create mode 100644 plugins/tipue-search/LICENSE create mode 100644 plugins/tipue-search/README.md create mode 100644 plugins/tipue-search/__init__.py create mode 100644 plugins/tipue-search/tipue_search.py (limited to 'plugins') diff --git a/plugins/another_read_more_link/.gitignore b/plugins/another_read_more_link/.gitignore new file mode 100644 index 0000000..72364f9 --- /dev/null +++ b/plugins/another_read_more_link/.gitignore @@ -0,0 +1,89 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover +.hypothesis/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# IPython Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# dotenv +.env + +# virtualenv +venv/ +ENV/ + +# Spyder project settings +.spyderproject + +# Rope project settings +.ropeproject diff --git a/plugins/another_read_more_link/LICENSE b/plugins/another_read_more_link/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/plugins/another_read_more_link/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/plugins/another_read_more_link/Readme.md b/plugins/another_read_more_link/Readme.md new file mode 100644 index 0000000..d8df841 --- /dev/null +++ b/plugins/another_read_more_link/Readme.md @@ -0,0 +1,33 @@ +##Pelican-plugins: Another Read More Link + + - Inspired by [Octopress](http://octopress.org/docs/blogging/) + - Reference to [read_more_link](https://github.com/getpelican/pelican-plugins/tree/master/read_more_link) + +" +Inserting a `` comment into your post will prevent the post content below this mark from being displayed on the index page for the blog posts, a "Continue →" button links to the full post. +" + +demo: [fangpeishi.com](http://fangpeishi.com) + +```css +.another-read-more-link { + background: #eee; + display: inline-block; + padding: .4em .4em; + margin-right: .5em; + text-decoration: none; + color: #737373; + transition: background-color 0.5s; +} +``` + +![demo](http://fangpeishi.com/images/2016/another_read_more_link_demo.jpg) + +###Settings + +``` + +ANOTHER_READ_MORE_LINK = "Read more" +ANOTHER_READ_MORE_LINK_FORMAT = '{text}' +READ_MORE_ID = 'read_more_link' +``` diff --git a/plugins/another_read_more_link/__init__.py b/plugins/another_read_more_link/__init__.py new file mode 100644 index 0000000..8b0ee46 --- /dev/null +++ b/plugins/another_read_more_link/__init__.py @@ -0,0 +1 @@ +from .another_read_more_link import * diff --git a/plugins/another_read_more_link/another_read_more_link.py b/plugins/another_read_more_link/another_read_more_link.py new file mode 100644 index 0000000..ce3a667 --- /dev/null +++ b/plugins/another_read_more_link/another_read_more_link.py @@ -0,0 +1,72 @@ +# -*- coding: utf-8 -*- + +from pelican import signals, contents +from pelican.utils import truncate_html_words +from pelican.generators import ArticlesGenerator + + +def insert_read_more_link(instance): + if type(instance) != contents.Article: + return + + if not instance._content: + instance.has_summary = False + return + + ANOTHER_READ_MORE_LINK = instance.settings.get('ANOTHER_READ_MORE_LINK', 'Continue ->') + READ_MORE_ID = instance.settings.get('READ_MORE_ID', 'read_more_link') + ANOTHER_READ_MORE_LINK_FORMAT = instance.settings.get('ANOTHER_READ_MORE_LINK_FORMAT', + '{text}') + + content = instance._update_content(instance._content, instance.settings.get('SITEURL')) + + marker_location = content.find("") + + if marker_location == -1: + if hasattr(instance, '_summary') or 'summary' in instance.metadata: + summary = instance._summary + else: + instance._summary = instance._content + instance.has_summary = True + return + else: + summary = content[0:marker_location] + + if ANOTHER_READ_MORE_LINK: + read_more_text = ANOTHER_READ_MORE_LINK.replace('{title}', instance.title) + if instance.settings.get('RELATIVE_URLS'): + read_more_link = ANOTHER_READ_MORE_LINK_FORMAT.format(url=instance.url, + text=read_more_text) + else: + absolute_url = '{}/{}'.format(instance.settings.get('SITEURL'), instance.url) + read_more_link = ANOTHER_READ_MORE_LINK_FORMAT.format(url=absolute_url, text=read_more_text) + # with id to link to the text just after the "read more" link + instance._content = '{}{}'.format(summary, + READ_MORE_ID, + content[marker_location:]) + summary += read_more_link + + # default_status was added to Pelican Content objects after 3.7.1. + # Its use here is strictly to decide on how to set the summary. + # There's probably a better way to do this but I couldn't find it. + if hasattr(instance, 'default_status'): + instance.metadata['summary'] = summary + else: + instance._summary = summary + instance.has_summary = True + + +def run_plugin(generators): + for generator in generators: + if isinstance(generator, ArticlesGenerator): + for article in generator.articles: + insert_read_more_link(article) + + +def register(): + try: + signals.all_generators_finalized.connect(run_plugin) + except AttributeError: + # NOTE: This may result in #314 so shouldn't really be relied on + # https://github.com/getpelican/pelican-plugins/issues/314 + signals.content_object_init.connect(insert_read_more_link) diff --git a/plugins/compressor/LICENSE b/plugins/compressor/LICENSE new file mode 100644 index 0000000..dba13ed --- /dev/null +++ b/plugins/compressor/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/plugins/compressor/README.md b/plugins/compressor/README.md new file mode 100644 index 0000000..79503c1 --- /dev/null +++ b/plugins/compressor/README.md @@ -0,0 +1,10 @@ +## Descripción + +Es un complemento para Pelican que minifica los archivos CSS y +JavaScript. Reemplaza los archivos JS y CSS por los archivos +minificados al momento de la compilación del sitio web. + +## Instalación + +Añade `compressor` a `pelicanconf.py`: `PLUGINS = +['compressor']`. diff --git a/plugins/compressor/__init__.py b/plugins/compressor/__init__.py new file mode 100644 index 0000000..ae36250 --- /dev/null +++ b/plugins/compressor/__init__.py @@ -0,0 +1,2 @@ +# -*- coding: utf-8 -*- +from .compressor import * diff --git a/plugins/compressor/compressor.py b/plugins/compressor/compressor.py new file mode 100644 index 0000000..af2d704 --- /dev/null +++ b/plugins/compressor/compressor.py @@ -0,0 +1,40 @@ +# -*- coding: utf-8 -*- +""" +css-js-minify wrapper for Pelican +""" + +import glob + +from .minify import ( + process_single_css_file, + process_single_js_file, +) + +from pelican import signals + +CSS_DIR = '/theme/css' +JS_DIR = '/theme/js' + + +def main(pelican): + """ Compiler """ + for file in glob.iglob(pelican.output_path + CSS_DIR + '/**/*.css', recursive=True): + process_single_css_file(file, overwrite=True) + for file in glob.iglob(pelican.output_path + JS_DIR + '/**/*.js', recursive=True): + process_single_js_file(file, overwrite=True) + + +def register(): + """ Register """ + signals.finalized.connect(main) + + +SUPPORT_JS = """ +----------------------------------------------------------------- +COMPRESSOR: +----------------------------------------------------------------- +Future JavaScript support is orphan and not supported! +If you want to make ES6,ES7 work feel free to send pull requests. +----------------------------------------------------------------- +""" +print(SUPPORT_JS) diff --git a/plugins/compressor/css_minifer.py b/plugins/compressor/css_minifer.py new file mode 100644 index 0000000..52a30e9 --- /dev/null +++ b/plugins/compressor/css_minifer.py @@ -0,0 +1,316 @@ +# -*- coding: utf-8 -*- + +"""CSS Minifier functions for CSS-HTML-JS-Minify.""" + +import re +import itertools + +from .variables import EXTENDED_NAMED_COLORS, CSS_PROPS_TEXT + + +__all__ = ('css_minify', 'condense_semicolons') + + +def _compile_props(props_text, grouped=False): + """Take a list of props and prepare them.""" + props, prefixes = [], "-webkit-,-khtml-,-epub-,-moz-,-ms-,-o-,".split(",") + for propline in props_text.strip().lower().splitlines(): + props += [pre + pro for pro in propline.split(" ") for pre in prefixes] + props = filter(lambda line: not line.startswith('#'), props) + if not grouped: + props = list(filter(None, props)) + return props, [0]*len(props) + final_props, groups, g_id = [], [], 0 + for prop in props: + if prop.strip(): + final_props.append(prop) + groups.append(g_id) + else: + g_id += 1 + return final_props, groups + + +def _prioritify(line_of_css, css_props_text_as_list): + """Return args priority, priority is integer and smaller means higher.""" + sorted_css_properties, groups_by_alphabetic_order = css_props_text_as_list + priority_integer, group_integer = 9999, 0 + for css_property in sorted_css_properties: + if css_property.lower() == line_of_css.split(":")[0].lower().strip(): + priority_integer = sorted_css_properties.index(css_property) + group_integer = groups_by_alphabetic_order[priority_integer] + break + return priority_integer, group_integer + + +def _props_grouper(props, pgs): + """Return groups for properties.""" + if not props: + return props + # props = sorted([ + # _ if _.strip().endswith(";") + # and not _.strip().endswith("*/") and not _.strip().endswith("/*") + # else _.rstrip() + ";\n" for _ in props]) + props_pg = zip(map(lambda prop: _prioritify(prop, pgs), props), props) + props_pg = sorted(props_pg, key=lambda item: item[0][1]) + props_by_groups = map( + lambda item: list(item[1]), + itertools.groupby(props_pg, key=lambda item: item[0][1])) + props_by_groups = map(lambda item: sorted( + item, key=lambda item: item[0][0]), props_by_groups) + props = [] + for group in props_by_groups: + group = map(lambda item: item[1], group) + props += group + props += ['\n'] + props.pop() + return props + + +def sort_properties(css_unsorted_string): + """CSS Property Sorter Function. + + This function will read buffer argument, split it to a list by lines, + sort it by defined rule, and return sorted buffer if it's CSS property. + This function depends on '_prioritify' function. + """ + css_pgs = _compile_props(CSS_PROPS_TEXT, grouped=False) # Do Not Group. + pattern = re.compile(r'(.*?{\r?\n?)(.*?)(}.*?)|(.*)', + re.DOTALL + re.MULTILINE) + matched_patterns = pattern.findall(css_unsorted_string) + sorted_patterns, sorted_buffer = [], css_unsorted_string + re_prop = re.compile(r'((?:.*?)(?:;)(?:.*?\n)|(?:.*))', + re.DOTALL + re.MULTILINE) + if len(matched_patterns) != 0: + for matched_groups in matched_patterns: + sorted_patterns += matched_groups[0].splitlines(True) + props = map(lambda line: line.lstrip('\n'), + re_prop.findall(matched_groups[1])) + props = list(filter(lambda line: line.strip('\n '), props)) + props = _props_grouper(props, css_pgs) + sorted_patterns += props + sorted_patterns += matched_groups[2].splitlines(True) + sorted_patterns += matched_groups[3].splitlines(True) + sorted_buffer = ''.join(sorted_patterns) + return sorted_buffer + + +def remove_comments(css): + """Remove all CSS comment blocks.""" + iemac, preserve = False, False + comment_start = css.find("/*") + while comment_start >= 0: # Preserve comments that look like `/*!...*/`. + # Slicing is used to make sure we dont get an IndexError. + preserve = css[comment_start + 2:comment_start + 3] == "!" + comment_end = css.find("*/", comment_start + 2) + if comment_end < 0: + if not preserve: + css = css[:comment_start] + break + elif comment_end >= (comment_start + 2): + if css[comment_end - 1] == "\\": + # This is an IE Mac-specific comment; leave this one and the + # following one alone. + comment_start = comment_end + 2 + iemac = True + elif iemac: + comment_start = comment_end + 2 + iemac = False + elif not preserve: + css = css[:comment_start] + css[comment_end + 2:] + else: + comment_start = comment_end + 2 + comment_start = css.find("/*", comment_start) + return css + + +def remove_unnecessary_whitespace(css): + """Remove unnecessary whitespace characters.""" + + def pseudoclasscolon(css): + """Prevent 'p :link' from becoming 'p:link'. + + Translates 'p :link' into 'p ___PSEUDOCLASSCOLON___link'. + This is translated back again later. + """ + regex = re.compile(r"(^|\})(([^\{\:])+\:)+([^\{]*\{)") + match = regex.search(css) + while match: + css = ''.join([ + css[:match.start()], + match.group().replace(":", "___PSEUDOCLASSCOLON___"), + css[match.end():]]) + match = regex.search(css) + return css + + css = pseudoclasscolon(css) + # Remove spaces from before things. + css = re.sub(r"\s+([!{};:>\(\)\],])", r"\1", css) + # If there is a `@charset`, then only allow one, and move to beginning. + css = re.sub(r"^(.*)(@charset \"[^\"]*\";)", r"\2\1", css) + css = re.sub(r"^(\s*@charset [^;]+;\s*)+", r"\1", css) + # Put the space back in for a few cases, such as `@media screen` and + # `(-webkit-min-device-pixel-ratio:0)`. + css = re.sub(r"\band\(", "and (", css) + # Put the colons back. + css = css.replace('___PSEUDOCLASSCOLON___', ':') + # Remove spaces from after things. + css = re.sub(r"([!{}:;>\(\[,])\s+", r"\1", css) + return css + + +def remove_unnecessary_semicolons(css): + """Remove unnecessary semicolons.""" + return re.sub(r";+\}", "}", css) + + +def remove_empty_rules(css): + """Remove empty rules.""" + return re.sub(r"[^\}\{]+\{\}", "", css) + + +def normalize_rgb_colors_to_hex(css): + """Convert `rgb(51,102,153)` to `#336699`.""" + regex = re.compile(r"rgb\s*\(\s*([0-9,\s]+)\s*\)") + match = regex.search(css) + while match: + colors = map(lambda s: s.strip(), match.group(1).split(",")) + hexcolor = '#%.2x%.2x%.2x' % tuple(map(int, colors)) + css = css.replace(match.group(), hexcolor) + match = regex.search(css) + return css + + +def condense_zero_units(css): + """Replace `0(px, em, %, etc)` with `0`.""" + return re.sub(r"([\s:])(0)(px|em|%|in|q|ch|cm|mm|pc|pt|ex|rem|s|ms|" + r"deg|grad|rad|turn|vw|vh|vmin|vmax|fr)", r"\1\2", css) + + +def condense_multidimensional_zeros(css): + """Replace `:0 0 0 0;`, `:0 0 0;` etc. with `:0;`.""" + return css.replace(":0 0 0 0;", ":0;").replace( + ":0 0 0;", ":0;").replace(":0 0;", ":0;").replace( + "background-position:0;", "background-position:0 0;").replace( + "transform-origin:0;", "transform-origin:0 0;") + + +def condense_floating_points(css): + """Replace `0.6` with `.6` where possible.""" + return re.sub(r"(:|\s)0+\.(\d+)", r"\1.\2", css) + + +def condense_hex_colors(css): + """Shorten colors from #AABBCC to #ABC where possible.""" + regex = re.compile( + r"""([^\"'=\s])(\s*)#([0-9a-f])([0-9a-f])([0-9a-f])""" + r"""([0-9a-f])([0-9a-f])([0-9a-f])""", re.I | re.S) + match = regex.search(css) + while match: + first = match.group(3) + match.group(5) + match.group(7) + second = match.group(4) + match.group(6) + match.group(8) + if first.lower() == second.lower(): + css = css.replace( + match.group(), match.group(1) + match.group(2) + '#' + first) + match = regex.search(css, match.end() - 3) + else: + match = regex.search(css, match.end()) + return css + + +def condense_whitespace(css): + """Condense multiple adjacent whitespace characters into one.""" + return re.sub(r"\s+", " ", css) + + +def condense_semicolons(css): + """Condense multiple adjacent semicolon characters into one.""" + return re.sub(r";;+", ";", css) + + +def wrap_css_lines(css, line_length=80): + """Wrap the lines of the given CSS to an approximate length.""" + lines, line_start = [], 0 + for i, char in enumerate(css): + # Its safe to break after } characters. + if char == '}' and (i - line_start >= line_length): + lines.append(css[line_start:i + 1]) + line_start = i + 1 + if line_start < len(css): + lines.append(css[line_start:]) + return '\n'.join(lines) + + +def condense_font_weight(css): + """Condense multiple font weights into shorter integer equals.""" + return css.replace('font-weight:normal;', 'font-weight:400;').replace( + 'font-weight:bold;', 'font-weight:700;') + + +def condense_std_named_colors(css): + """Condense named color values to shorter replacement using HEX.""" + for color_name, color_hexa in iter(tuple({ + ':aqua;': ':#0ff;', ':blue;': ':#00f;', + ':fuchsia;': ':#f0f;', ':yellow;': ':#ff0;'}.items())): + css = css.replace(color_name, color_hexa) + return css + + +def condense_xtra_named_colors(css): + """Condense named color values to shorter replacement using HEX.""" + for k, v in iter(tuple(EXTENDED_NAMED_COLORS.items())): + same_color_but_rgb = 'rgb({0},{1},{2})'.format(v[0], v[1], v[2]) + if len(k) > len(same_color_but_rgb): + css = css.replace(k, same_color_but_rgb) + return css + + +def remove_url_quotes(css): + """Fix for url() does not need quotes.""" + return re.sub(r'url\((["\'])([^)]*)\1\)', r'url(\2)', css) + + +def condense_border_none(css): + """Condense border:none; to border:0;.""" + return css.replace("border:none;", "border:0;") + + +def add_encoding(css): + """Add @charset 'UTF-8'; if missing.""" + return '@charset "utf-8";' + css if "@charset" not in css.lower() else css + + +def restore_needed_space(css): + """Fix CSS for some specific cases where a white space is needed.""" + return css.replace("!important", " !important").replace( # !important + "@media(", "@media (").replace( # media queries # jpeg > jpg + "data:image/jpeg;base64,", "data:image/jpg;base64,").rstrip("\n;") + + +def unquote_selectors(css): + """Fix CSS for some specific selectors where Quotes is not needed.""" + return re.compile('([a-zA-Z]+)="([a-zA-Z0-9-_\.]+)"]').sub(r'\1=\2]', css) + + +def css_minify(css, wrap=False, comments=False, sort=False, noprefix=False): + """Minify CSS main function.""" + css = remove_comments(css) if not comments else css + css = sort_properties(css) if sort else css + css = unquote_selectors(css) + css = condense_whitespace(css) + css = remove_url_quotes(css) + css = condense_xtra_named_colors(css) + css = condense_font_weight(css) + css = remove_unnecessary_whitespace(css) + css = condense_std_named_colors(css) + css = remove_unnecessary_semicolons(css) + css = condense_zero_units(css) + css = condense_multidimensional_zeros(css) + css = condense_floating_points(css) + css = normalize_rgb_colors_to_hex(css) + css = condense_hex_colors(css) + css = condense_border_none(css) + css = wrap_css_lines(css, 80) if wrap else css + css = condense_semicolons(css) + css = add_encoding(css) if not noprefix else css + css = restore_needed_space(css) + return css.strip() diff --git a/plugins/compressor/js_minifer.py b/plugins/compressor/js_minifer.py new file mode 100644 index 0000000..6654b76 --- /dev/null +++ b/plugins/compressor/js_minifer.py @@ -0,0 +1,171 @@ +# -*- coding: utf-8 -*- + +"""JavaScript Minifier functions for CSS-JS-Minify.""" + +import re +from io import StringIO # pure-Python StringIO supports unicode. +from .css_minifer import condense_semicolons + +__all__ = ('js_minify', ) + + +def remove_commented_lines(js): + """Force remove commented out lines from Javascript.""" + result = "" + for line in js.splitlines(): + line = re.sub(r"/\*.*\*/", "", line) # (/*COMMENT */) + line = re.sub(r"//.*", "", line) # (//COMMENT) + result += '\n'+line + return result + + +def simple_replacer_js(js): + """Force strip simple replacements from Javascript.""" + return condense_semicolons(js.replace("debugger;", ";").replace( + ";}", "}").replace("; ", ";").replace(" ;", ";").rstrip("\n;")) + + +def js_minify_keep_comments(js): + """Return a minified version of the Javascript string.""" + ins, outs = StringIO(js), StringIO() + JavascriptMinify(ins, outs).minify() + return force_single_line_js(outs.getvalue()) + + +def force_single_line_js(js): + """Force Javascript to a single line, even if need to add semicolon.""" + return ";".join(js.splitlines()) if len(js.splitlines()) > 1 else js + + +class JavascriptMinify(object): + + """Minify an input stream of Javascript, writing to an output stream.""" + + def __init__(self, instream=None, outstream=None): + """Init class.""" + self.ins, self.outs = instream, outstream + + def minify(self, instream=None, outstream=None): + """Minify Javascript using StringIO.""" + if instream and outstream: + self.ins, self.outs = instream, outstream + write, read = self.outs.write, self.ins.read + space_strings = ("abcdefghijklmnopqrstuvwxyz" + "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_$\\") + starters, enders = '{[(+-', '}])+-"\'' + newlinestart_strings = starters + space_strings + newlineend_strings = enders + space_strings + do_newline, do_space = False, False + doing_single_comment, doing_multi_comment = False, False + previous_before_comment, in_quote = '', '' + in_re, quote_buf = False, [] + previous = read(1) + next1 = read(1) + if previous == '/': + if next1 == '/': + doing_single_comment = True + elif next1 == '*': + doing_multi_comment = True + else: + write(previous) + elif not previous: + return + elif previous >= '!': + if previous in "'\"": + in_quote = previous + write(previous) + previous_non_space = previous + else: + previous_non_space = ' ' + if not next1: + return + while True: + next2 = read(1) + if not next2: + last = next1.strip() + conditional_1 = (doing_single_comment or doing_multi_comment) + if not conditional_1 and last not in ('', '/'): + write(last) + break + if doing_multi_comment: + if next1 == '*' and next2 == '/': + doing_multi_comment = False + next2 = read(1) + elif doing_single_comment: + if next1 in '\r\n': + doing_single_comment = False + while next2 in '\r\n': + next2 = read(1) + if not next2: + break + if previous_before_comment in ')}]': + do_newline = True + elif previous_before_comment in space_strings: + write('\n') + elif in_quote: + quote_buf.append(next1) + + if next1 == in_quote: + numslashes = 0 + for c in reversed(quote_buf[:-1]): + if c != '\\': + break + else: + numslashes += 1 + if numslashes % 2 == 0: + in_quote = '' + write(''.join(quote_buf)) + elif next1 in '\r\n': + conditional_2 = previous_non_space in newlineend_strings + if conditional_2 or previous_non_space > '~': + while 1: + if next2 < '!': + next2 = read(1) + if not next2: + break + else: + conditional_3 = next2 in newlinestart_strings + if conditional_3 or next2 > '~' or next2 == '/': + do_newline = True + break + elif next1 < '!' and not in_re: + conditional_4 = next2 in space_strings or next2 > '~' + conditional_5 = previous_non_space in space_strings + conditional_6 = previous_non_space > '~' + if (conditional_5 or conditional_6) and (conditional_4): + do_space = True + elif next1 == '/': + if in_re: + if previous != '\\': + in_re = False + write('/') + elif next2 == '/': + doing_single_comment = True + previous_before_comment = previous_non_space + elif next2 == '*': + doing_multi_comment = True + else: + in_re = previous_non_space in '(,=:[?!&|' + write('/') + else: + if do_space: + do_space = False + write(' ') + if do_newline: + write('\n') + do_newline = False + write(next1) + if not in_re and next1 in "'\"": + in_quote = next1 + quote_buf = [] + previous = next1 + next1 = next2 + if previous >= '!': + previous_non_space = previous + + +def js_minify(js): + """Minify a JavaScript string.""" + js = remove_commented_lines(js) + js = js_minify_keep_comments(js) + return js.strip() diff --git a/plugins/compressor/minify.py b/plugins/compressor/minify.py new file mode 100644 index 0000000..9107882 --- /dev/null +++ b/plugins/compressor/minify.py @@ -0,0 +1,266 @@ +# -*- coding: utf-8 -*- + +"""CSS-JS-Minify. + +Minifier for the Web. +""" + +import os +import sys +import gzip +# import logging as log + +from argparse import ArgumentParser +from datetime import datetime +from functools import partial +from hashlib import sha1 +from multiprocessing import Pool, cpu_count +from subprocess import getoutput +from time import sleep + +from .css_minifer import css_minify +from .js_minifer import js_minify + + +__all__ = ('process_multiple_files', 'prefixer_extensioner', + 'process_single_css_file', 'process_single_js_file', + 'make_arguments_parser', 'main') + +color = { + 'cyan': '\033[1;36m', + 'end': '\033[0m', + 'green': '\033[1;32m' +} + + +def process_multiple_files(file_path, watch=False, wrap=False, timestamp=False, + comments=False, sort=False, overwrite=False, + zipy=False, prefix='', add_hash=False): + """Process multiple CSS, JS files with multiprocessing.""" + print("Process %s is Compressing %s" % (os.getpid(), file_path)) + if watch: + previous = int(os.stat(file_path).st_mtime) + print("Process %s is Watching %s" % (os.getpid(), file_path)) + while True: + actual = int(os.stat(file_path).st_mtime) + if previous == actual: + sleep(60) + else: + previous = actual + print("Modification detected on %s" % file_path) + if file_path.endswith(".css"): + process_single_css_file( + file_path, wrap=wrap, timestamp=timestamp, + comments=comments, sort=sort, overwrite=overwrite, + zipy=zipy, prefix=prefix, add_hash=add_hash) + elif file_path.endswith(".js"): + process_single_js_file( + file_path, timestamp=timestamp, + overwrite=overwrite, zipy=zipy) + else: + if file_path.endswith(".css"): + process_single_css_file( + file_path, wrap=wrap, timestamp=timestamp, + comments=comments, sort=sort, overwrite=overwrite, zipy=zipy, + prefix=prefix, add_hash=add_hash) + elif file_path.endswith(".js"): + process_single_js_file( + file_path, timestamp=timestamp, + overwrite=overwrite, zipy=zipy) + + +def prefixer_extensioner(file_path, old, new, + file_content=None, prefix='', add_hash=False): + """Take a file path and safely preppend a prefix and change extension. + + This is needed because filepath.replace('.foo', '.bar') sometimes may + replace '/folder.foo/file.foo' into '/folder.bar/file.bar' wrong!. + >>> prefixer_extensioner('/tmp/test.js', '.js', '.min.js') + '/tmp/test.min.js' + """ + print("Prepending '%s' Prefix to %s" % (new.upper(), file_path)) + + extension = os.path.splitext(file_path)[1].lower().replace(old, new) + filenames = os.path.splitext(os.path.basename(file_path))[0] + filenames = prefix + filenames if prefix else filenames + if add_hash and file_content: # http://stackoverflow.com/a/25568916 + filenames += "-" + sha1(file_content.encode("utf-8")).hexdigest()[:11] + print("Appending SHA1 HEX-Digest Hash to '%s'" % file_path) + dir_names = os.path.dirname(file_path) + file_path = os.path.join(dir_names, filenames + extension) + return file_path + + +def process_single_css_file(css_file_path, wrap=False, timestamp=False, + comments=False, sort=False, overwrite=False, + zipy=False, prefix='', add_hash=False, + output_path=None): + """Process a single CSS file.""" + print("Processing %sCSS%s file: %s" % (color['cyan'], + color['end'], + css_file_path)) + with open(css_file_path, encoding="utf-8") as css_file: + original_css = css_file.read() + + print("INPUT: Reading CSS file %s" % css_file_path) + + minified_css = css_minify(original_css, wrap=wrap, + comments=comments, sort=sort) + if timestamp: + taim = "/* {0} */ ".format(datetime.now().isoformat()[:-7].lower()) + minified_css = taim + minified_css + if output_path is None: + min_css_file_path = prefixer_extensioner( + css_file_path, ".css", ".css" if overwrite else ".min.css", + original_css, prefix=prefix, add_hash=add_hash) + if zipy: + gz_file_path = prefixer_extensioner( + css_file_path, ".css", + ".css.gz" if overwrite else ".min.css.gz", original_css, + prefix=prefix, add_hash=add_hash) + print("OUTPUT: Writing ZIP CSS %s" % gz_file_path) + else: + min_css_file_path = gz_file_path = output_path + if not zipy or output_path is None: + # if specific output path is requested,write write only one output file + with open(min_css_file_path, "w", encoding="utf-8") as output_file: + output_file.write(minified_css) + if zipy: + with gzip.open(gz_file_path, "wt", encoding="utf-8") as output_gz: + output_gz.write(minified_css) + + print("OUTPUT: Writing CSS Minified %s" % min_css_file_path) + + return min_css_file_path + + +def process_single_js_file(js_file_path, timestamp=False, overwrite=False, + zipy=False, output_path=None): + """Process a single JS file.""" + print("Processing %sJS%s file: %s" % (color['green'], + color['end'], + js_file_path)) + with open(js_file_path, encoding="utf-8") as js_file: + original_js = js_file.read() + print("INPUT: Reading JS file %s" % js_file_path) + minified_js = js_minify(original_js) + if timestamp: + taim = "/* {} */ ".format(datetime.now().isoformat()[:-7].lower()) + minified_js = taim + minified_js + if output_path is None: + min_js_file_path = prefixer_extensioner( + js_file_path, ".js", ".js" if overwrite else ".min.js", + original_js) + if zipy: + gz_file_path = prefixer_extensioner( + js_file_path, ".js", ".js.gz" if overwrite else ".min.js.gz", + original_js) + print("OUTPUT: Writing ZIP JS %s" % gz_file_path) + else: + min_js_file_path = gz_file_path = output_path + if not zipy or output_path is None: + # if specific output path is requested,write write only one output file + with open(min_js_file_path, "w", encoding="utf-8") as output_file: + output_file.write(minified_js) + if zipy: + with gzip.open(gz_file_path, "wt", encoding="utf-8") as output_gz: + output_gz.write(minified_js) + print("OUTPUT: Writing JS Minified %s" % min_js_file_path) + return min_js_file_path + + +def make_arguments_parser(): + """Build and return a command line agument parser.""" + parser = ArgumentParser(description=__doc__, epilog="""CSS-JS-Minify: + Takes a file or folder full path string and process all CSS/JS found. + If argument is not file/folder will fail. Check Updates works on Python3. + Std-In to Std-Out is deprecated since it may fail with unicode characters. + SHA1 HEX-Digest 11 Chars Hash on Filenames is used for Server Cache. + CSS Properties are Alpha-Sorted, to help spot cloned ones, Selectors not. + Watch works for whole folders, with minimum of ~60 Secs between runs.""") + # parser.add_argument('--version', action='version', + # version=css_js_minify.__version__) + parser.add_argument('fullpath', metavar='fullpath', type=str, + help='Full path to local file or folder.') + parser.add_argument('--wrap', action='store_true', + help="Wrap output to ~80 chars per line, CSS only.") + parser.add_argument('--prefix', type=str, + help="Prefix string to prepend on output filenames.") + parser.add_argument('--timestamp', action='store_true', + help="Add a Time Stamp on all CSS/JS output files.") + parser.add_argument('--quiet', action='store_true', help="Quiet, Silent.") + parser.add_argument('--hash', action='store_true', + help="Add SHA1 HEX-Digest 11chars Hash to Filenames.") + parser.add_argument('--zipy', action='store_true', + help="GZIP Minified files as '*.gz', CSS/JS only.") + parser.add_argument('--sort', action='store_true', + help="Alphabetically Sort CSS Properties, CSS only.") + parser.add_argument('--comments', action='store_true', + help="Keep comments, CSS only (Not Recommended)") + parser.add_argument('--overwrite', action='store_true', + help="Force overwrite all in-place (Not Recommended)") + parser.add_argument('--after', type=str, + help="Command to execute after run (Experimental).") + parser.add_argument('--before', type=str, + help="Command to execute before run (Experimental).") + parser.add_argument('--watch', action='store_true', help="Watch changes.") + parser.add_argument('--multiple', action='store_true', + help="Allow Multiple instances (Not Recommended).") + return parser.parse_args() + + +def walk2list(folder: str, target: tuple, omit: tuple = (), + showhidden: bool = False, topdown: bool = True, + onerror: object = None, followlinks: bool = False) -> tuple: + """Perform full walk, gather full path of all files.""" + oswalk = os.walk(folder, topdown=topdown, + onerror=onerror, followlinks=followlinks) + + return [os.path.abspath(os.path.join(r, f)) + for r, d, fs in oswalk + for f in fs if not f.startswith(() if showhidden else ".") and + not f.endswith(omit) and f.endswith(target)] + + +def main(): + """Main Loop.""" + args = make_arguments_parser() + if os.path.isfile(args.fullpath) and args.fullpath.endswith(".css"): + print("Target is a CSS File.") # Work based on if argument is + list_of_files = str(args.fullpath) # file or folder, folder is slower. + process_single_css_file( + args.fullpath, wrap=args.wrap, timestamp=args.timestamp, + comments=args.comments, sort=args.sort, overwrite=args.overwrite, + zipy=args.zipy, prefix=args.prefix, add_hash=args.hash) + elif os.path.isfile(args.fullpath) and args.fullpath.endswith(".js"): + print("Target is a JS File.") + list_of_files = str(args.fullpath) + process_single_js_file( + args.fullpath, timestamp=args.timestamp, + overwrite=args.overwrite, zipy=args.zipy) + elif os.path.isdir(args.fullpath): + print("Target is a Folder with CSS, JS files !.") + print("Processing a whole Folder may take some time...") + list_of_files = walk2list( + args.fullpath, + (".css", ".js" if args.overwrite else None), + (".min.css", ".min.js" if args.overwrite else None)) + print("Total Maximum CPUs used: ~%s Cores." % cpu_count()) + pool = Pool(cpu_count()) # Multiprocessing Async + pool.map_async(partial( + process_multiple_files, watch=args.watch, + wrap=args.wrap, timestamp=args.timestamp, + comments=args.comments, sort=args.sort, + overwrite=args.overwrite, zipy=args.zipy, + prefix=args.prefix, add_hash=args.hash), + list_of_files) + pool.close() + pool.join() + else: + print("File or folder not found,or cant be read,or I/O Error.") + sys.exit(1) + if args.after and getoutput: + print(getoutput(str(args.after))) + print("\n %s \n Files Processed: %s" % ("-" * 80, list_of_files)) + print("Number of Files Processed: %s" % + (len(list_of_files) if isinstance(list_of_files, tuple) else 1)) diff --git a/plugins/compressor/variables.py b/plugins/compressor/variables.py new file mode 100644 index 0000000..8003730 --- /dev/null +++ b/plugins/compressor/variables.py @@ -0,0 +1,211 @@ +# -*- coding: utf-8 -*- + +"""Variables for CSS processing for CSS-JS-Minify.""" + +__all__ = ('EXTENDED_NAMED_COLORS', 'CSS_PROPS_TEXT') + +# 'Color Name String': (R, G, B) +EXTENDED_NAMED_COLORS = { + 'azure': (240, 255, 255), + 'beige': (245, 245, 220), + 'bisque': (255, 228, 196), + 'blanchedalmond': (255, 235, 205), + 'brown': (165, 42, 42), + 'burlywood': (222, 184, 135), + 'chartreuse': (127, 255, 0), + 'chocolate': (210, 105, 30), + 'coral': (255, 127, 80), + 'cornsilk': (255, 248, 220), + 'crimson': (220, 20, 60), + 'cyan': (0, 255, 255), + 'darkcyan': (0, 139, 139), + 'darkgoldenrod': (184, 134, 11), + 'darkgray': (169, 169, 169), + 'darkgreen': (0, 100, 0), + 'darkgrey': (169, 169, 169), + 'darkkhaki': (189, 183, 107), + 'darkmagenta': (139, 0, 139), + 'darkolivegreen': (85, 107, 47), + 'darkorange': (255, 140, 0), + 'darkorchid': (153, 50, 204), + 'darkred': (139, 0, 0), + 'darksalmon': (233, 150, 122), + 'darkseagreen': (143, 188, 143), + 'darkslategray': (47, 79, 79), + 'darkslategrey': (47, 79, 79), + 'darkturquoise': (0, 206, 209), + 'darkviolet': (148, 0, 211), + 'deeppink': (255, 20, 147), + 'dimgray': (105, 105, 105), + 'dimgrey': (105, 105, 105), + 'firebrick': (178, 34, 34), + 'forestgreen': (34, 139, 34), + 'gainsboro': (220, 220, 220), + 'gold': (255, 215, 0), + 'goldenrod': (218, 165, 32), + 'gray': (128, 128, 128), + 'green': (0, 128, 0), + 'grey': (128, 128, 128), + 'honeydew': (240, 255, 240), + 'hotpink': (255, 105, 180), + 'indianred': (205, 92, 92), + 'indigo': (75, 0, 130), + 'ivory': (255, 255, 240), + 'khaki': (240, 230, 140), + 'lavender': (230, 230, 250), + 'lavenderblush': (255, 240, 245), + 'lawngreen': (124, 252, 0), + 'lemonchiffon': (255, 250, 205), + 'lightcoral': (240, 128, 128), + 'lightcyan': (224, 255, 255), + 'lightgray': (211, 211, 211), + 'lightgreen': (144, 238, 144), + 'lightgrey': (211, 211, 211), + 'lightpink': (255, 182, 193), + 'lightsalmon': (255, 160, 122), + 'lightseagreen': (32, 178, 170), + 'lightslategray': (119, 136, 153), + 'lightslategrey': (119, 136, 153), + 'lime': (0, 255, 0), + 'limegreen': (50, 205, 50), + 'linen': (250, 240, 230), + 'magenta': (255, 0, 255), + 'maroon': (128, 0, 0), + 'mediumorchid': (186, 85, 211), + 'mediumpurple': (147, 112, 219), + 'mediumseagreen': (60, 179, 113), + 'mediumspringgreen': (0, 250, 154), + 'mediumturquoise': (72, 209, 204), + 'mediumvioletred': (199, 21, 133), + 'mintcream': (245, 255, 250), + 'mistyrose': (255, 228, 225), + 'moccasin': (255, 228, 181), + 'navy': (0, 0, 128), + 'oldlace': (253, 245, 230), + 'olive': (128, 128, 0), + 'olivedrab': (107, 142, 35), + 'orange': (255, 165, 0), + 'orangered': (255, 69, 0), + 'orchid': (218, 112, 214), + 'palegoldenrod': (238, 232, 170), + 'palegreen': (152, 251, 152), + 'paleturquoise': (175, 238, 238), + 'palevioletred': (219, 112, 147), + 'papayawhip': (255, 239, 213), + 'peachpuff': (255, 218, 185), + 'peru': (205, 133, 63), + 'pink': (255, 192, 203), + 'plum': (221, 160, 221), + 'purple': (128, 0, 128), + 'rosybrown': (188, 143, 143), + 'saddlebrown': (139, 69, 19), + 'salmon': (250, 128, 114), + 'sandybrown': (244, 164, 96), + 'seagreen': (46, 139, 87), + 'seashell': (255, 245, 238), + 'sienna': (160, 82, 45), + 'silver': (192, 192, 192), + 'slategray': (112, 128, 144), + 'slategrey': (112, 128, 144), + 'snow': (255, 250, 250), + 'springgreen': (0, 255, 127), + 'teal': (0, 128, 128), + 'thistle': (216, 191, 216), + 'tomato': (255, 99, 71), + 'turquoise': (64, 224, 208), + 'violet': (238, 130, 238), + 'wheat': (245, 222, 179) +} + + +# Do Not compact this string, new lines are used to Group up stuff. +CSS_PROPS_TEXT = ''' + +alignment-adjust alignment-baseline animation animation-delay +animation-direction animation-duration animation-iteration-count +animation-name animation-play-state animation-timing-function appearance +azimuth + +backface-visibility background background-blend-mode background-attachment +background-clip background-color background-image background-origin +background-position background-position-block background-position-inline +background-position-x background-position-y background-repeat background-size +baseline-shift bikeshedding bookmark-label bookmark-level bookmark-state +bookmark-target border border-bottom border-bottom-color +border-bottom-left-radius border-bottom-parts border-bottom-right-radius +border-bottom-style border-bottom-width border-clip border-clip-top +border-clip-right border-clip-bottom border-clip-left border-collapse +border-color border-corner-shape border-image border-image-outset +border-image-repeat border-image-slice border-image-source border-image-width +border-left border-left-color border-left-style border-left-parts +border-left-width border-limit border-parts border-radius border-right +border-right-color border-right-style border-right-width border-right-parts +border-spacing border-style border-top border-top-color border-top-left-radius +border-top-parts border-top-right-radius border-top-style border-top-width +border-width bottom box-decoration-break box-shadow box-sizing + +caption-side clear clip color column-count column-fill column-gap column-rule +column-rule-color column-rule-style column-rule-width column-span column-width +columns content counter-increment counter-reset corners corner-shape +cue cue-after cue-before cursor + +direction display drop-initial-after-adjust drop-initial-after-align +drop-initial-before-adjust drop-initial-before-align drop-initial-size +drop-initial-value + +elevation empty-cells + +flex flex-basis flex-direction flex-flow flex-grow flex-shrink flex-wrap fit +fit-position float font font-family font-size font-size-adjust font-stretch +font-style font-variant font-weight + +grid-columns grid-rows + +justify-content + +hanging-punctuation height hyphenate-character hyphenate-resource hyphens + +icon image-orientation image-resolution inline-box-align + +left letter-spacing line-height line-stacking line-stacking-ruby +line-stacking-shift line-stacking-strategy linear-gradient list-style +list-style-image list-style-position list-style-type + +margin margin-bottom margin-left margin-right margin-top marquee-direction +marquee-loop marquee-speed marquee-style max-height max-width min-height +min-width + +nav-index + +opacity orphans outline outline-color outline-offset outline-style +outline-width overflow overflow-style overflow-x overflow-y + +padding padding-bottom padding-left padding-right padding-top page +page-break-after page-break-before page-break-inside pause pause-after +pause-before perspective perspective-origin pitch pitch-range play-during +position presentation-level + +quotes + +resize rest rest-after rest-before richness right rotation rotation-point +ruby-align ruby-overhang ruby-position ruby-span + +size speak speak-header speak-numeral speak-punctuation speech-rate src +stress string-set + +table-layout target target-name target-new target-position text-align +text-align-last text-decoration text-emphasis text-indent text-justify +text-outline text-shadow text-transform text-wrap top transform +transform-origin transition transition-delay transition-duration +transition-property transition-timing-function + +unicode-bidi unicode-range + +vertical-align visibility voice-balance voice-duration voice-family +voice-pitch voice-range voice-rate voice-stress voice-volume volume + +white-space widows width word-break word-spacing word-wrap + +z-index + +''' diff --git a/plugins/get_app_version/LICENSE b/plugins/get_app_version/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/plugins/get_app_version/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/plugins/get_app_version/README.md b/plugins/get_app_version/README.md new file mode 100644 index 0000000..3233051 --- /dev/null +++ b/plugins/get_app_version/README.md @@ -0,0 +1,24 @@ +App version +============ + +A Pelican plugin to show app version from git. + +Copyright (c) 2020 - Jesús E. + +How to use +========== + +In your pelicanconf.py, add: + + PLUGINS = ['get_app_version'] + +In your template, add: + + {% if CURRENT_VERSION and CURRENT_BRANCH %} +
{{ _('Current version:') }} {{ CURRENT_VERSION }} @ {{ CURRENT_BRANCH }}
+ {% endif %} + +License +======= + +This work is under the License [GNU GPLv3+](LICENSE) diff --git a/plugins/get_app_version/__init__.py b/plugins/get_app_version/__init__.py new file mode 100644 index 0000000..2d5290f --- /dev/null +++ b/plugins/get_app_version/__init__.py @@ -0,0 +1 @@ +from .get_app_version import * diff --git a/plugins/get_app_version/get_app_version.py b/plugins/get_app_version/get_app_version.py new file mode 100644 index 0000000..bd671a7 --- /dev/null +++ b/plugins/get_app_version/get_app_version.py @@ -0,0 +1,41 @@ +from __future__ import unicode_literals + +import os +import subprocess + +from pelican import signals + + +def app_version(generator): + def minimal_env_cmd(cmd): + # make minimal environment + env = {} + for k in ['SYSTEMROOT', 'PATH']: + v = os.environ.get(k) + if v is not None: + env[k] = v + + env['LANGUAGE'] = 'C' + env['LANG'] = 'C' + env['LC_ALL'] = 'C' + out = subprocess.Popen( + cmd, stdout=subprocess.PIPE, env=env).communicate()[0] + return out + + try: + # version + describe = minimal_env_cmd(["git", "describe", "--always"]) + git_revision = describe.strip().decode('ascii') + # branch + branch = minimal_env_cmd(["git", "branch"]) + git_branch = branch.strip().decode('ascii').replace('* ', '') + except OSError: + git_revision = "Unknown" + git_branch = "Unknown" + + generator.context['CURRENT_VERSION'] = git_revision + generator.context['CURRENT_BRANCH'] = git_branch + + +def register(): + signals.generator_init.connect(app_version) diff --git a/plugins/i18n_subsites/README.rst b/plugins/i18n_subsites/README.rst new file mode 100644 index 0000000..340109b --- /dev/null +++ b/plugins/i18n_subsites/README.rst @@ -0,0 +1,165 @@ +======================= + I18N Sub-sites Plugin +======================= + +This plugin extends the translations functionality by creating +internationalized sub-sites for the default site. + +This plugin is designed for Pelican 3.4 and later. + +What it does +============ + +1. When the content of the main site is being generated, the settings + are saved and the generation stops when content is ready to be + written. While reading source files and generating content objects, + the output queue is modified in certain ways: + + - translations that will appear as native in a different (sub-)site + will be removed + - untranslated articles will be transformed to drafts if + ``I18N_UNTRANSLATED_ARTICLES`` is ``'hide'`` (default), removed if + ``'remove'`` or kept as they are if ``'keep'``. + - untranslated pages will be transformed into hidden pages if + ``I18N_UNTRANSLATED_PAGES`` is ``'hide'`` (default), removed if + ``'remove'`` or kept as they are if ``'keep'``.'' + - additional content manipulation similar to articles and pages can + be specified for custom generators in the ``I18N_GENERATOR_INFO`` + setting. + +2. For each language specified in the ``I18N_SUBSITES`` dictionary the + settings overrides are applied to the settings from the main site + and a new sub-site is generated in the same way as with the main + site until content is ready to be written. +3. When all (sub-)sites are waiting for content writing, all removed + contents, translations and static files are interlinked across the + (sub-)sites. +4. Finally, all the output is written. + +Setting it up +============= + +For each extra used language code, a language-specific settings overrides +dictionary must be given (but can be empty) in the ``I18N_SUBSITES`` dictionary + +.. code-block:: python + + PLUGINS = ['i18n_subsites', ...] + + # mapping: language_code -> settings_overrides_dict + I18N_SUBSITES = { + 'cz': { + 'SITENAME': 'Hezkej blog', + } + } + +You must also have the following in your pelican configuration + +.. code-block:: python + JINJA_ENVIRONMENT = { + 'extensions': ['jinja2.ext.i18n'], + } + + + +Default and special overrides +----------------------------- +The settings overrides may contain arbitrary settings, however, there +are some that are handled in a special way: + +``SITEURL`` + Any overrides to this setting should ensure that there is some level + of hierarchy between all (sub-)sites, because Pelican makes all URLs + relative to ``SITEURL`` and the plugin can only cross-link between + the sites using this hierarchy. For instance, with the main site + ``http://example.com`` a sub-site ``http://example.com/de`` will + work, but ``http://de.example.com`` will not. If not overridden, the + language code (the language identifier used in the ``lang`` + metadata) is appended to the main ``SITEURL`` for each sub-site. +``OUTPUT_PATH``, ``CACHE_PATH`` + If not overridden, the language code is appended as with ``SITEURL``. + Separate cache paths are required as parser results depend on the locale. +``STATIC_PATHS``, ``THEME_STATIC_PATHS`` + If not overridden, they are set to ``[]`` and all links to static + files are cross-linked to the main site. +``THEME``, ``THEME_STATIC_DIR`` + If overridden, the logic with ``THEME_STATIC_PATHS`` does not apply. +``DEFAULT_LANG`` + This should not be overridden as the plugin changes it to the + language code of each sub-site to change what is perceived as translations. + +Localizing templates +-------------------- + +Most importantly, this plugin can use localized templates for each +sub-site. There are two approaches to having the templates localized: + +- You can set a different ``THEME`` override for each language in + ``I18N_SUBSITES``, e.g. by making a copy of a theme ``my_theme`` to + ``my_theme_lang`` and then editing the templates in the new + localized theme. This approach means you don't have to deal with + gettext ``*.po`` files, but it is harder to maintain over time. +- You use only one theme and localize the templates using the + `jinja2.ext.i18n Jinja2 extension + `_. For a kickstart + read this `guide <./localizing_using_jinja2.rst>`_. + +Additional context variables +............................ + +It may be convenient to add language buttons to your theme in addition +to the translation links of articles and pages. These buttons could, +for example, point to the ``SITEURL`` of each (sub-)site. For this +reason the plugin adds these variables to the template context: + +``main_lang`` + The language of the main site — the original ``DEFAULT_LANG`` +``main_siteurl`` + The ``SITEURL`` of the main site — the original ``SITEURL`` +``lang_siteurls`` + An ordered dictionary, mapping all used languages to their + ``SITEURL``. The ``main_lang`` is the first key with ``main_siteurl`` + as the value. This dictionary is useful for implementing global + language buttons that show the language of the currently viewed + (sub-)site too. +``extra_siteurls`` + An ordered dictionary, subset of ``lang_siteurls``, the current + ``DEFAULT_LANG`` of the rendered (sub-)site is not included, so for + each (sub-)site ``set(extra_siteurls) == set(lang_siteurls) - + set([DEFAULT_LANG])``. This dictionary is useful for implementing + global language buttons that do not show the current language. +``relpath_to_site`` + A function that returns a relative path from the first (sub-)site to + the second (sub-)site where the (sub-)sites are identified by the + language codes given as two arguments. + +If you don't like the default ordering of the ordered dictionaries, +use a Jinja2 filter to alter the ordering. + +All the siteurls above are always absolute even in the case of +``RELATIVE_URLS == True`` (it would be to complicated to replicate the +Pelican internals for local siteurls), so you may rather use something +like ``{{ SITEURL }}/{{ relpath_to_site(DEFAULT_LANG, main_lang }}`` +to link to the main site. + +This short `howto <./implementing_language_buttons.rst>`_ shows two +example implementations of language buttons. + +Usage notes +=========== +- It is **mandatory** to specify ``lang`` metadata for each article + and page as ``DEFAULT_LANG`` is later changed for each sub-site, so + content without ``lang`` metadata would be rendered in every + (sub-)site. +- As with the original translations functionality, ``slug`` metadata + is used to group translations. It is therefore often convenient to + compensate for this by overriding the content URL (which defaults to + slug) using the ``url`` and ``save_as`` metadata. You could also + give articles e.g. ``name`` metadata and use it in ``ARTICLE_URL = + '{name}.html'``. + +Development +=========== + +- A demo and a test site is in the ``gh-pages`` branch and can be seen + at http://smartass101.github.io/pelican-plugins/ diff --git a/plugins/i18n_subsites/__init__.py b/plugins/i18n_subsites/__init__.py new file mode 100644 index 0000000..7dfbde0 --- /dev/null +++ b/plugins/i18n_subsites/__init__.py @@ -0,0 +1 @@ +from .i18n_subsites import * diff --git a/plugins/i18n_subsites/i18n_subsites.py b/plugins/i18n_subsites/i18n_subsites.py new file mode 100644 index 0000000..33cfaab --- /dev/null +++ b/plugins/i18n_subsites/i18n_subsites.py @@ -0,0 +1,469 @@ +"""i18n_subsites plugin creates i18n-ized subsites of the default site + +This plugin is designed for Pelican 3.4 and later +""" + + +import os +import six +import logging +import posixpath + +from copy import copy +from itertools import chain +from operator import attrgetter +try: + from collections.abc import OrderedDict +except ImportError: + from collections import OrderedDict +from contextlib import contextmanager +from six.moves.urllib.parse import urlparse + +import gettext +import locale + +from pelican import signals +from pelican.generators import ArticlesGenerator, PagesGenerator +from pelican.settings import configure_settings +try: + from pelican.contents import Draft +except ImportError: + from pelican.contents import Article as Draft + + +# Global vars +_MAIN_SETTINGS = None # settings dict of the main Pelican instance +_MAIN_LANG = None # lang of the main Pelican instance +_MAIN_SITEURL = None # siteurl of the main Pelican instance +_MAIN_STATIC_FILES = None # list of Static instances the main Pelican +_SUBSITE_QUEUE = {} # map: lang -> settings overrides +_SITE_DB = OrderedDict() # OrderedDict: lang -> siteurl +_SITES_RELPATH_DB = {} # map: (lang, base_lang) -> relpath +# map: generator -> list of removed contents that need interlinking +_GENERATOR_DB = {} +_NATIVE_CONTENT_URL_DB = {} # map: source_path -> content in its native lang +_LOGGER = logging.getLogger(__name__) + + +@contextmanager +def temporary_locale(temp_locale=None): + '''Enable code to run in a context with a temporary locale + + Resets the locale back when exiting context. + Can set a temporary locale if provided + ''' + orig_locale = locale.setlocale(locale.LC_ALL) + if temp_locale is not None: + locale.setlocale(locale.LC_ALL, temp_locale) + yield + locale.setlocale(locale.LC_ALL, orig_locale) + + +def initialize_dbs(settings): + '''Initialize internal DBs using the Pelican settings dict + + This clears the DBs for e.g. autoreload mode to work + ''' + global _MAIN_SETTINGS, _MAIN_SITEURL, _MAIN_LANG, _SUBSITE_QUEUE + _MAIN_SETTINGS = settings + _MAIN_LANG = settings['DEFAULT_LANG'] + _MAIN_SITEURL = settings['SITEURL'] + _SUBSITE_QUEUE = settings.get('I18N_SUBSITES', {}).copy() + prepare_site_db_and_overrides() + # clear databases in case of autoreload mode + _SITES_RELPATH_DB.clear() + _NATIVE_CONTENT_URL_DB.clear() + _GENERATOR_DB.clear() + + +def prepare_site_db_and_overrides(): + '''Prepare overrides and create _SITE_DB + + _SITE_DB.keys() need to be ready for filter_translations + ''' + + _SITE_DB.clear() + _SITE_DB[_MAIN_LANG] = _MAIN_SITEURL + + # make sure it works for both root-relative and absolute + + main_siteurl = ('/' if _MAIN_SITEURL == '' else _MAIN_SITEURL) + for (lang, overrides) in _SUBSITE_QUEUE.items(): + if 'SITEURL' not in overrides: + overrides['SITEURL'] = posixpath.join(main_siteurl, lang) + _SITE_DB[lang] = overrides['SITEURL'] + + # default subsite hierarchy + + if 'OUTPUT_PATH' not in overrides: + overrides['OUTPUT_PATH'] = \ + os.path.join(_MAIN_SETTINGS['OUTPUT_PATH'], lang) + if 'CACHE_PATH' not in overrides: + overrides['CACHE_PATH'] = \ + os.path.join(_MAIN_SETTINGS['CACHE_PATH'], lang) + if 'STATIC_PATHS' not in overrides: + overrides['STATIC_PATHS'] = [] + if 'THEME' not in overrides and 'THEME_STATIC_DIR' \ + not in overrides and 'THEME_STATIC_PATHS' not in overrides: + relpath = relpath_to_site(lang, _MAIN_LANG) + overrides['THEME_STATIC_DIR'] = posixpath.join( + relpath, _MAIN_SETTINGS['THEME_STATIC_DIR']) + overrides['THEME_STATIC_PATHS'] = [] + + # to change what is perceived as translations + + overrides['DEFAULT_LANG'] = lang + + +def subscribe_filter_to_signals(settings): + '''Subscribe content filter to requested signals''' + for sig in settings.get('I18N_FILTER_SIGNALS', []): + sig.connect(filter_contents_translations) + + +def initialize_plugin(pelican_obj): + '''Initialize plugin variables and Pelican settings''' + if _MAIN_SETTINGS is None: + initialize_dbs(pelican_obj.settings) + subscribe_filter_to_signals(pelican_obj.settings) + + +def get_site_path(url): + '''Get the path component of an url, excludes siteurl + + also normalizes '' to '/' for relpath to work, + otherwise it could be interpreted as a relative filesystem path + ''' + path = urlparse(url).path + if path == '': + path = '/' + return path + + +def relpath_to_site(lang, target_lang): + '''Get relative path from siteurl of lang to siteurl of base_lang + + the output is cached in _SITES_RELPATH_DB + ''' + path = _SITES_RELPATH_DB.get((lang, target_lang), None) + if path is None: + siteurl = _SITE_DB.get(lang, _MAIN_SITEURL) + target_siteurl = _SITE_DB.get(target_lang, _MAIN_SITEURL) + path = posixpath.relpath(get_site_path(target_siteurl), + get_site_path(siteurl)) + _SITES_RELPATH_DB[(lang, target_lang)] = path + return path + + +def save_generator(generator): + '''Save the generator for later use + + initialize the removed content list + ''' + _GENERATOR_DB[generator] = [] + + +def article2draft(article): + '''Transform an Article to Draft''' + draft = Draft(article._content, article.metadata, article.settings, + article.source_path, article._context) + draft.status = 'draft' + return draft + + +def page2hidden_page(page): + '''Transform a Page to a hidden Page''' + page.status = 'hidden' + return page + + +class GeneratorInspector(object): + '''Inspector of generator instances''' + + generators_info = { + ArticlesGenerator: { + 'translations_lists': ['translations', 'drafts_translations'], + 'contents_lists': [('articles', 'drafts')], + 'hiding_func': article2draft, + 'policy': 'I18N_UNTRANSLATED_ARTICLES', + }, + PagesGenerator: { + 'translations_lists': ['translations', 'hidden_translations'], + 'contents_lists': [('pages', 'hidden_pages')], + 'hiding_func': page2hidden_page, + 'policy': 'I18N_UNTRANSLATED_PAGES', + }, + } + + def __init__(self, generator): + '''Identify the best known class of the generator instance + + The class ''' + self.generator = generator + self.generators_info.update(generator.settings.get( + 'I18N_GENERATORS_INFO', {})) + for cls in generator.__class__.__mro__: + if cls in self.generators_info: + self.info = self.generators_info[cls] + break + else: + self.info = {} + + def translations_lists(self): + '''Iterator over lists of content translations''' + return (getattr(self.generator, name) for name in + self.info.get('translations_lists', [])) + + def contents_list_pairs(self): + '''Iterator over pairs of normal and hidden contents''' + return (tuple(getattr(self.generator, name) for name in names) + for names in self.info.get('contents_lists', [])) + + def hiding_function(self): + '''Function for transforming content to a hidden version''' + hiding_func = self.info.get('hiding_func', lambda x: x) + return hiding_func + + def untranslated_policy(self, default): + '''Get the policy for untranslated content''' + return self.generator.settings.get(self.info.get('policy', None), + default) + + def all_contents(self): + '''Iterator over all contents''' + translations_iterator = chain(*self.translations_lists()) + return chain(translations_iterator, + *(pair[i] for pair in self.contents_list_pairs() + for i in (0, 1))) + + +def filter_contents_translations(generator): + '''Filter the content and translations lists of a generator + + Filters out + 1) translations which will be generated in a different site + 2) content that is not in the language of the currently + generated site but in that of a different site, content in a + language which has no site is generated always. The filtering + method bay be modified by the respective untranslated policy + ''' + inspector = GeneratorInspector(generator) + current_lang = generator.settings['DEFAULT_LANG'] + langs_with_sites = _SITE_DB.keys() + removed_contents = _GENERATOR_DB[generator] + + for translations in inspector.translations_lists(): + for translation in translations[:]: # copy to be able to remove + if translation.lang in langs_with_sites: + translations.remove(translation) + removed_contents.append(translation) + + hiding_func = inspector.hiding_function() + untrans_policy = inspector.untranslated_policy(default='hide') + for (contents, other_contents) in inspector.contents_list_pairs(): + for content in other_contents: # save any hidden native content first + if content.lang == current_lang: # in native lang + # save the native URL attr formatted in the current locale + _NATIVE_CONTENT_URL_DB[content.source_path] = content.url + for content in contents[:]: # copy for removing in loop + if content.lang == current_lang: # in native lang + # save the native URL attr formatted in the current locale + _NATIVE_CONTENT_URL_DB[content.source_path] = content.url + elif content.lang in langs_with_sites and untrans_policy != 'keep': + contents.remove(content) + if untrans_policy == 'hide': + other_contents.append(hiding_func(content)) + elif untrans_policy == 'remove': + removed_contents.append(content) + + +def install_templates_translations(generator): + '''Install gettext translations in the jinja2.Environment + + Only if the 'jinja2.ext.i18n' jinja2 extension is enabled + the translations for the current DEFAULT_LANG are installed. + ''' + if 'JINJA_ENVIRONMENT' in generator.settings: # pelican 3.7+ + jinja_extensions = generator.settings['JINJA_ENVIRONMENT'].get( + 'extensions', []) + else: + jinja_extensions = generator.settings['JINJA_EXTENSIONS'] + + if 'jinja2.ext.i18n' in jinja_extensions: + domain = generator.settings.get('I18N_GETTEXT_DOMAIN', 'messages') + localedir = generator.settings.get('I18N_GETTEXT_LOCALEDIR') + if localedir is None: + localedir = os.path.join(generator.theme, 'translations') + current_lang = generator.settings['DEFAULT_LANG'] + if current_lang == generator.settings.get('I18N_TEMPLATES_LANG', + _MAIN_LANG): + translations = gettext.NullTranslations() + else: + langs = [current_lang] + try: + translations = gettext.translation(domain, localedir, langs) + except (IOError, OSError): + _LOGGER.error(( + "Cannot find translations for language '{}' in '{}' with " + "domain '{}'. Installing NullTranslations.").format( + langs[0], localedir, domain)) + translations = gettext.NullTranslations() + newstyle = generator.settings.get('I18N_GETTEXT_NEWSTYLE', True) + generator.env.install_gettext_translations(translations, newstyle) + + +def add_variables_to_context(generator): + '''Adds useful iterable variables to template context''' + context = generator.context # minimize attr lookup + context['relpath_to_site'] = relpath_to_site + context['main_siteurl'] = _MAIN_SITEURL + context['main_lang'] = _MAIN_LANG + context['lang_siteurls'] = _SITE_DB + current_lang = generator.settings['DEFAULT_LANG'] + extra_siteurls = _SITE_DB.copy() + extra_siteurls.pop(current_lang) + context['extra_siteurls'] = extra_siteurls + + +def interlink_translations(content): + '''Link content to translations in their main language + + so the URL (including localized month names) of the different subsites + will be honored + ''' + lang = content.lang + # sort translations by lang + content.translations.sort(key=attrgetter('lang')) + for translation in content.translations: + relpath = relpath_to_site(lang, translation.lang) + url = _NATIVE_CONTENT_URL_DB[translation.source_path] + translation.override_url = posixpath.join(relpath, url) + + +def interlink_translated_content(generator): + '''Make translations link to the native locations + + for generators that may contain translated content + ''' + inspector = GeneratorInspector(generator) + for content in inspector.all_contents(): + interlink_translations(content) + + +def interlink_removed_content(generator): + '''For all contents removed from generation queue update interlinks + + link to the native location + ''' + current_lang = generator.settings['DEFAULT_LANG'] + for content in _GENERATOR_DB[generator]: + url = _NATIVE_CONTENT_URL_DB[content.source_path] + relpath = relpath_to_site(current_lang, content.lang) + content.override_url = posixpath.join(relpath, url) + + +def interlink_static_files(generator): + '''Add links to static files in the main site if necessary''' + if generator.settings['STATIC_PATHS'] != []: + return # customized STATIC_PATHS + try: # minimize attr lookup + static_content = generator.context['static_content'] + except KeyError: + static_content = generator.context['filenames'] + relpath = relpath_to_site(generator.settings['DEFAULT_LANG'], _MAIN_LANG) + for staticfile in _MAIN_STATIC_FILES: + if staticfile.get_relative_source_path() not in static_content: + staticfile = copy(staticfile) # prevent override in main site + staticfile.override_url = posixpath.join(relpath, staticfile.url) + try: + generator.add_source_path(staticfile, static=True) + except TypeError: + generator.add_source_path(staticfile) + + +def save_main_static_files(static_generator): + '''Save the static files generated for the main site''' + global _MAIN_STATIC_FILES + # test just for current lang as settings change in autoreload mode + if static_generator.settings['DEFAULT_LANG'] == _MAIN_LANG: + _MAIN_STATIC_FILES = static_generator.staticfiles + + +def update_generators(): + '''Update the context of all generators + + Ads useful variables and translations into the template context + and interlink translations + ''' + for generator in _GENERATOR_DB.keys(): + install_templates_translations(generator) + add_variables_to_context(generator) + interlink_static_files(generator) + interlink_removed_content(generator) + interlink_translated_content(generator) + + +def get_pelican_cls(settings): + '''Get the Pelican class requested in settings''' + cls = settings['PELICAN_CLASS'] + if isinstance(cls, six.string_types): + module, cls_name = cls.rsplit('.', 1) + module = __import__(module) + cls = getattr(module, cls_name) + return cls + + +def create_next_subsite(pelican_obj): + '''Create the next subsite using the lang-specific config + + If there are no more subsites in the generation queue, update all + the generators (interlink translations and removed content, add + variables and translations to template context). Otherwise get the + language and overrides for next the subsite in the queue and apply + overrides. Then generate the subsite using a PELICAN_CLASS + instance and its run method. Finally, restore the previous locale. + ''' + global _MAIN_SETTINGS + if len(_SUBSITE_QUEUE) == 0: + _LOGGER.debug( + 'i18n: Updating cross-site links and context of all generators.') + update_generators() + _MAIN_SETTINGS = None # to initialize next time + else: + with temporary_locale(): + settings = _MAIN_SETTINGS.copy() + lang, overrides = _SUBSITE_QUEUE.popitem() + settings.update(overrides) + settings = configure_settings(settings) # to set LOCALE, etc. + cls = get_pelican_cls(settings) + + new_pelican_obj = cls(settings) + _LOGGER.debug(("Generating i18n subsite for language '{}' " + "using class {}").format(lang, cls)) + new_pelican_obj.run() + + +# map: signal name -> function name +_SIGNAL_HANDLERS_DB = { + 'get_generators': initialize_plugin, + 'article_generator_pretaxonomy': filter_contents_translations, + 'page_generator_finalized': filter_contents_translations, + 'get_writer': create_next_subsite, + 'static_generator_finalized': save_main_static_files, + 'generator_init': save_generator, +} + + +def register(): + '''Register the plugin only if required signals are available''' + for sig_name in _SIGNAL_HANDLERS_DB.keys(): + if not hasattr(signals, sig_name): + _LOGGER.error(( + 'The i18n_subsites plugin requires the {} ' + 'signal available for sure in Pelican 3.4.0 and later, ' + 'plugin will not be used.').format(sig_name)) + return + + for sig_name, handler in _SIGNAL_HANDLERS_DB.items(): + sig = getattr(signals, sig_name) + sig.connect(handler) diff --git a/plugins/i18n_subsites/implementing_language_buttons.rst b/plugins/i18n_subsites/implementing_language_buttons.rst new file mode 100644 index 0000000..43f8bb3 --- /dev/null +++ b/plugins/i18n_subsites/implementing_language_buttons.rst @@ -0,0 +1,128 @@ +----------------------------- +Implementing language buttons +----------------------------- + +Each article with translations has translations links, but that's the +only way to switch between language subsites. + +For this reason it is convenient to add language buttons to the top +menu bar to make it simple to switch between the language subsites on +all pages. + +Example designs +--------------- + +Language buttons showing other available languages +.................................................. + +The ``extra_siteurls`` dictionary is a mapping of all other (not the +``DEFAULT_LANG`` of the current (sub-)site) languages to the +``SITEURL`` of the respective (sub-)sites + +.. code-block:: jinja + + +