exu/wiki-grav
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

(Grav GitSync) Automatic Commit from RealStickman

Browse Source
This commit is contained in:
RealStickman 2022-05-27 15:47:01 +02:00 committed by GitSync
parent bbe561a84e
commit 85d649f9a1
17 changed files with 2578 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
plugins/external_links/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
.idea

189
plugins/external_links/CHANGELOG.md Normal file
View File

@ -0,0 +1,189 @@
# v1.6.3
## 01/26/2021
1. [](#improved)
* Updated plugin blueprints for Grav 1.7
# v1.6.2
## 10/28/2019
1. [](#improved)
* FlexObjects compatibility: change references to `Page` class to use `PageInterface`
* Updated Grav requirements to 1.6 or greater (thanks to [@mahagr](https://github.com/mahagr) for the heads-up)
# v1.6.1
## 07/12/2018
3. [](#bugfix)
* Fixed parsing tags other than links [#24](https://github.com/Sommerregen/grav-plugin-external-links/pull/24) (Fix loading of a href element)
# v1.6.0
## 02/22/2018
1. [](#new)
* Check for page redirects [#22](https://github.com/Sommerregen/grav-plugin-external-links/pull/22) (Check for redirecting pages if `links.redirects` is enabled, thanks to [@karfau](https://github.com/karfau))
2. [](#improved)
* Set `rel="noopener noreferrer"` to all external links [#21](https://github.com/Sommerregen/grav-plugin-external-links/issues/21)
* Updated French translation strings [#19](https://github.com/Sommerregen/grav-plugin-external-links/pull/19)
* Improved `README.md` and YAML files
# v1.5.3
## 02/18/2017
3. [](#bugfix)
* Fixed Russian translation strings [#17](https://github.com/Sommerregen/grav-plugin-external-links/pull/17) (Thanks to [@geschke](https://github.com/geschke) for the fast PR)
# v1.5.2
## 02/17/2017
1. [](#new)
* Added Russian translations [#16](https://github.com/Sommerregen/grav-plugin-external-links/pull/16) (Thanks to [@ktaranov](https://github.com/ktaranov))
# v1.5.1
## 02/10/2017
3. [](#bugfix)
* Fixed error in getting the remote image size
# v1.5.0
## 02/09/2017
2. [](#improved)
* Use tabs in admin panel settings for better user experience
* Use toggle buttons for page settings
# v1.4.4
## 01/11/2017
3. [](#bugfix)
* Fixed `CURLOPT_AUTOREFERER` constant
# v1.4.3
## 10/31/2016
3. [](#bugfix)
* Fixed [#11](https://github.com/Sommerregen/grav-plugin-external-links/issues/11) (Not working with cache enabling) (see PR [#15](https://github.com/Sommerregen/grav-plugin-external-links/pull/15))
* Fixed [#13](https://github.com/Sommerregen/grav-plugin-external-links/issues/13) (Preferences Not Showing)
# v1.4.2
## 12/06/2015
1. [](#new)
* Added French translations [#8](https://github.com/Sommerregen/grav-plugin-external-links/pull/8) (Thanks to [@MATsxm](https://github.com/MATsxm))
# v1.4.1
## 11/18/2015
2. [](#improved)
* Page specific options now respect the default configurations set in the admin panel
# v1.4.0
## 11/17/2015
1. [](#new)
* Added `External Links` options to page options tab
2. [](#improved)
* Improved `isExternalUrl` function to allow custom schemes and whether to evaluate links beginning with `.www` or not
* Added more blueprint options
* Improved code
* Updated docs
3. [](#bugfix)
* Fixed [#7](https://github.com/Sommerregen/grav-plugin-external-links/issues/7) (Possible issue with malformed URLs)
* Fixes `external_links` filter function
# v1.3.1
## 09/09/2015
2. [](#improved)
* Added blueprints for Grav Admin plugin
3. [](#bugfix)
* Fixed [#5](https://github.com/Sommerregen/grav-plugin-external-links/issues/5) (Works on first page displayed)
* Fixed [#6](https://github.com/Sommerregen/grav-plugin-external-links/issues/6) (Validation failed: title is not defined in blueprints)
# v1.3.0
## 08/08/2015
1. [](#new)
* Added admin configurations **(requires Grav 0.9.34+)**
* Added multi-language support **(requires Grav 0.9.33+)**
* Added default title message for external links
2. [](#improved)
* Switched to `onBuildPagesInitialized` event **(requires Grav 0.9.29+)**
* Updated `README.md`
3. [](#bugfix)
* Fixed [#4](https://github.com/Sommerregen/grav-plugin-external-links/issues/4) (Problem with non UTF-8 characters)
# v1.2.2
## 05/10/2015
2. [](#improved)
* PSR fixes
# v1.2.1
## 03/24/2015
3. [](#bugfix)
* Fixed active `mode` condition
# v1.2.0
## 02/21/2015
1. [](#new)
* Added option `mode` to parse links passively (where no CSS classes are set) and actively
2. [](#improved)
* Allow multiple classes to exclude in option `exclude.classes`
* Improved process engine to ensure not to alter HTML tags or HTML entities in content
* Refactored code
# v1.1.3
## 02/10/2015
3. [](#bugfix)
* Fixed self-closing tags in HTML5 and ensured to return contents compliant to HTML(5)
# v1.1.2
## 02/10/2015
1. [](#new)
* By default `External Links` now uses the class `external-links` for CSS styling; using `external` is still possible e.g. for manually markup external links
2. [](#improved)
* Improved usage example in `README.md`
3. [](#bugfix)
* Fixed [#1](https://github.com/Sommerregen/grav-plugin-external-links/issues/4) (Issue with LightSlider plugin)
# v1.1.1
## 02/06/2015
1. [](#new)
* Added usage example in `README.md`
* Add icons next to external links via CSS when using class `external` only
2. [](#improved)
* Added support for HHVM **(requires Grav 0.9.17+)**
* Added modular pages support
3. [](#bugfix)
* Fixed regular expression in `isExternalUrl($url)` method
# v1.1.0
## 02/05/2015
1. [](#new)
* IMPORTANT: Changed names of external link classes with images to `image`, `images` and `no-image`
2. [](#improved)
* Improved readability of code
* Updated plugin to use new `mergeConfig` method of Grav core
* Improved and corrected calculations of image size
3. [](#bugfix)
* Fixed some typo in the documentation
* Fixed and removed additional `<body>` tag from page content
# v1.0.1
## 01/29/2015
1. [](#improved)
* Fixed minor issues (broken README link, removed debugging functions)
# v1.0.0
## 01/29/2015
1. [](#new)
* ChangeLog started...

727
plugins/external_links/LICENSE Normal file
View File

@ -0,0 +1,727 @@
Grav External Links Plugin License
==================================
Grav External Links Plugin is meant to be a free and open source for all now
and in future.
For ease of distribution, Grav External Links Plugin is licensed under a dual
license and is based on the principle of Give-and-Take.
Unless otherwise noted Grav External Links Plugin is licensed under the terms
of GPLv3 <http://opensource.org/licenses/GPL-3.0> (or see license text below).
However it is licensed under the terms of MIT
<http://opensource.org/licenses/MIT>
(or see license text below) when the following conditions are met:
- Grav External Links Plugin is used, copied, merged, published for or
distributed with Grav (http://getgrav.org)
and can be understood as a Free and Open Source Software ("FOSS") License
Exception especially for all plugins, themes, extensions available for Grav
using Grav External Links Plugin in any way.
MIT LICENSE
-----------
Copyright (c) 2017+ Benjamin Regler, https://github.com/sommerregen/grav-plugin-external-links
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
GPL VERSION 3
-------------
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
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.
{one line to give the program's name and a brief idea of what it does.}
Copyright (C) {year} {name of author}
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 <http://www.gnu.org/licenses/>.
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:
{project} Copyright (C) {year} {fullname}
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
<http://www.gnu.org/licenses/>.
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
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

192
plugins/external_links/README.md Normal file
View File

@ -0,0 +1,192 @@
# [![Grav External Links Plugin](assets/logo.png)][project]
[![Release](https://img.shields.io/github/release/sommerregen/grav-plugin-external-links.svg)][project] [![Issues](https://img.shields.io/github/issues/sommerregen/grav-plugin-external-links.svg)][issues] [![Dual license](https://img.shields.io/badge/dual%20license-MIT%2FGPL-blue.svg)](LICENSE "License")
> This plugin adds small icons to external and mailto links, informing users the link will take them to a new site or open their email client.
**Note:** [hibbitts-design/grav-plugin-external-links](https://github.com/hibbitts-design/grav-plugin-external-links) is the new master repository for this plugin (see [getgrav/grav#2711](https://github.com/getgrav/grav/issues/2711)). Thanks to [@Sommerregen](https://github.com/Sommerregen) for originally developing this Plugin!
##### Table of Contents:
* [About](#about)
* [Installation and Updates](#installation-and-updates)
* [Usage](#usage)
* [Example](#example)
* [CSS Stylesheet Override](#css-stylesheet-override)
* [Twig Filter](#twig-filter)
* [Contributing](#contributing)
* [License](#license)
## About
`External Links` is a high-quality plugin for [GetGrav.org](http://getgrav.org) used to differentiate between internal and external links. It also includes the ability of adding `rel="nofollow"` to links and determines how external links shall be opened via the `target` attribute. [Wikipedia](https://www.wikipedia.org/) is a well-known example.
Furthermore it enables you to specify multiple domains, each of them on a new line to prevent them from being seen as external sites.
If you are interested in seeing this plugin in action, here is a screenshot:
![Screenshot External Links Plugin](assets/screenshot.png "External Links Preview")
## Installation and Updates
Installing or updating the `External Links` plugin can be done in one of two ways. Using the GPM (Grav Package Manager) installation update method (i.e. `bin/gpm install external_links`) or manual install by downloading [this plugin](https://github.com/sommerregen/grav-plugin-external-links) and extracting all plugin files to
/your/site/grav/user/plugins/external_links
For more informations, please check the [Installation and update guide](docs/INSTALL.md).
## Usage
The `External Links` plugin comes with some sensible default configuration, that are pretty self explanatory:
### Config Defaults
```yaml
# Global plugin configurations
enabled: true # Set to false to disable this plugin completely
built_in_css: true # Use built-in CSS of the plugin
weight: 0 # Set the weight (order of execution)
# Default options for External Links configuration
exclude:
classes: [exclude] # Exclude all links with this class
domains: # A list of domains to be excluded e.g
# - localhost/* # (any RegExp can be used)
# - img.domain.com/*
links:
www: false # Autom. link any hostname that starts with "www."
redirects: false # Also mark links as external, that link to pages that redirect to an external URL
schemes: # Allowed schemes
- 'http'
- 'https'
- 'ftp'
- 'irc'
- 'mailto'
- 'news'
- 'nntp'
- 'rtsp'
- 'sftp'
- 'ssh'
- 'tel'
- 'telnet'
- 'webcal'
# Global and page specific configurations
process: true # Filter external links
title: false # Sets default title for external links
no_follow: true # Add rel="nofollow" to all external links
target: "_blank" # Set target attribute of link
mode: "active" # active = process and parse all links;
# passive = parse links, but don't set CSS classes
```
If you need to change any value, then the best process is to copy the [external_links.yaml](external_links.yaml) file into your `users/config/plugins/` folder (create it if it doesn't exist), and then modify there. This will override the default settings.
If you want to alter the settings for one or a few pages only, you can do so by adding page specific configurations into your page headers, e.g.
```yaml
external_links: false
```
to switch off `External Links` plugin just for this page.
### Example
By default `External Links` adds a small icon to external or mailto links and opens by default links in a new tab. Any links in your Markdown file i.e. of the form
```markdown
[External Link text](http://domain.com)
or
[External Link text](https://domain.com)
```
will then be recognized as an external link (an icon on the right is showing up), whereas
```markdown
[My arcticle](my-article)
```
will not. You can exclude specific domains not to be seen as external either by adding them to the `exlcude.domains` option or by adding a class (default: `exclude`) to the desired links as in the following:
```markdown
[Domain without external link icon](http://my-specific-domain.com) {.exclude}
```
> Please note that **Markdown Extra** should be enabled in your `user/config/systems.yaml` via `pages.markdown.extra: true` in order to add classes to these links.
Sometimes you maybe wish to explicitly set a link to be "external". Although this should happen in really rare cases, since `External links` plugin will automatically detect external links, it is possible. Provided that **Markdown Extra** is enabled, adding the class `external` to the link will do the trick:
```markdown
[Always show external link icon](my-external-article) {.external}
```
### CSS Stylesheet Override
Something you might want to do is to override the look and feel of the external links, and with Grav it is super easy.
Copy the stylesheet [assets/css/external_links.css](assets/css/external_links.css) into the `css` folder of your custom theme, and add it to the list of CSS files.
user/themes/custom-theme/css/external_links.css
After that set the `built_in_css` option of the `External Links` plugin to `false`. That's it.
You can now edit, override and tweak it however you prefer. However, this plugin adds extra classes for styling to every link, you might wanna know:
- `external`, `external-link` -- Used to identify external links.
- `mailto` -- Used to identify mailto links.
- `no-image` -- Set if a link does not contain any image tags.
- `icon`-- Set if a link contains an image (with size <= 32px).
- `image` -- Set if a link contains an image (with size > 32px).
- `images` -- Set if a link contains more than one image.
### Twig Filter
`External Links` provides a Twig filter to process external links inside contents. To do that, place the following line of code in the theme file you wish to add the `External Links` plugin for:
```
{{ page.content|external_links }}
```
You can pass arguments to the plugin filter, namely the same arguments as available in the [external_links.yaml](external_links.yaml) file. For example
```
{{ page.content|external_links({'mode': 'passive'}) }}
```
will change the mode of the `External Links` filter to parse links, but don't set CSS classes.
## Contributing
You can contribute at any time! Before opening any issue, please search for existing issues and review the [guidelines for contributing](docs/CONTRIBUTING.md).
After that please note:
* If you find a bug, would like to make a feature request or suggest an improvement, [please open a new issue][issues]. If you have any interesting ideas for additions to the syntax please do suggest them as well!
* Feature requests are more likely to get attention if you include a clearly described use case.
* If you wish to submit a pull request, please make again sure that your request match the [guidelines for contributing](docs/CONTRIBUTING.md) and that you keep track of adding unit tests for any new or changed functionality.
## License
Copyright (c) 2017+ [Benjamin Regler][github]. See also the list of [contributors] who participated in this project.
[Dual-licensed](LICENSE) for use under the terms of the [MIT][mit-license] or [GPLv3][gpl-license] licenses.
![GNU license - Some rights reserved][gnu]
[github]: https://github.com/sommerregen/ "GitHub account from Benjamin Regler"
[gpl-license]: http://opensource.org/licenses/GPL-3.0 "GPLv3 license"
[mit-license]: http://www.opensource.org/licenses/mit-license.php "MIT license"
[gnu]: https://upload.wikimedia.org/wikipedia/commons/thumb/3/33/License_icon-gpl-88x31.svg/88px-License_icon-gpl-88x31.svg.png "GNU license - Some rights reserved"
[project]: https://github.com/sommerregen/grav-plugin-external-links
[issues]: https://github.com/sommerregen/grav-plugin-external-links/issues "GitHub Issues for Grav External Links Plugin"
[contributors]: https://github.com/sommerregen/grav-plugin-external-links/graphs/contributors "List of contributors of the project"

39
plugins/external_links/assets/css/external_links.css Normal file
View File

@ -0,0 +1,39 @@
a.external-link.icon, a.external-link.no-image, a.external, a.external {
background: url(../images/link.png) right center no-repeat;
padding-right: 12px;
position: relative;
}
a.mailto {
background: url(../images/mail.png) right center no-repeat;
padding-right: 12px;
}
.external-link[data-title]:after {
background-color: #444;
color: #fff;
content: attr(data-title);
display: inline;
font-size: xx-small;
font-weight: bold;
margin: -1em 0 0 16px;
min-width: 45em;
opacity: 0;
padding: .25em .5em;
position: absolute;
top: 50%;
transition: all 1s ease-in-out 1s;
visibility: hidden;
}
.external-link[data-title]:hover:after {
opacity: 1;
visibility: visible;
}
/* Hide link or mailto icons when printing. */
@media print {
a.external, a.external-link, a.mailto {
background-image: none;
padding: 0;
}
}

BIN
plugins/external_links/assets/images/link.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 196 B

BIN
plugins/external_links/assets/images/mail.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 187 B

BIN
plugins/external_links/assets/logo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
plugins/external_links/assets/screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 23 KiB

194
plugins/external_links/blueprints.yaml Normal file
View File

@ -0,0 +1,194 @@
name: 'External Links'
type: plugin
slug: external_links
version: '1.6.3'
description: 'This plugin adds small icons to external and mailto links, informing users the link will take them to a new site or open their email client.'
icon: 'external-link'
author:
name: 'Hibbitts Design'
email: 'hello@hibbittsdesign.org'
homepage: 'https://github.com/hibbitts-design/grav-plugin-external-links'
keywords: ['external', 'links', 'filter', 'formatter', 'plugin']
docs: 'https://github.com/hibbitts-design/grav-plugin-external-links/blob/master/README.md'
bugs: 'https://github.com/hibbitts-design/grav-plugin-external-links/issues'
license: 'MIT/GPL'
dependencies:
- { name: grav, version: ">=1.6" }
form:
validation: strict
fields:
tabs:
type: tabs
active: 1
class: subtle
fields:
external_links:
type: tab
title: PLUGINS.EXTERNAL_LINKS.PLUGIN_NAME
fields:
enabled:
type: toggle
label: PLUGIN_ADMIN.PLUGIN_STATUS
help: PLUGINS.EXTERNAL_LINKS.STATUS_HELP
highlight: 1
default: 1
options:
1: PLUGIN_ADMIN.ENABLED
0: PLUGIN_ADMIN.DISABLED
validate:
type: bool
built_in_css:
type: toggle
label: PLUGINS.EXTERNAL_LINKS.BUILTIN_CSS
highlight: 1
default: 1
options:
1: PLUGIN_ADMIN.YES
0: PLUGIN_ADMIN.NO
validate:
type: bool
weight:
type: text
size: x-small
label: PLUGINS.EXTERNAL_LINKS.WEIGHT
default: 0
validate:
type: int
min: -100
max: 100
settings:
type: tab
title: PLUGINS.EXTERNAL_LINKS.SETTINGS
fields:
links:
type: section
title: PLUGINS.EXTERNAL_LINKS.LINKS.SECTION
text: PLUGINS.EXTERNAL_LINKS.LINKS.SECTION_HELP
fields:
links.www:
type: toggle
label: PLUGINS.EXTERNAL_LINKS.LINKS.WWW
help: PLUGINS.EXTERNAL_LINKS.LINKS.WWW_HELP
default: 0
options:
1: PLUGIN_ADMIN.YES
0: PLUGIN_ADMIN.NO
validate:
type: bool
links.redirects:
type: toggle
label: PLUGINS.EXTERNAL_LINKS.LINKS.REDIRECTS
help: PLUGINS.EXTERNAL_LINKS.LINKS.REDIRECTS_HELP
default: 0
options:
1: PLUGIN_ADMIN.YES
0: PLUGIN_ADMIN.NO
validate:
type: bool
links.schemes:
type: selectize
size: large
label: PLUGINS.EXTERNAL_LINKS.LINKS.SCHEMES
help: PLUGINS.EXTERNAL_LINKS.LINKS.SCHEMES_HELP
validate:
type: commalist
exclude:
type: section
title: PLUGINS.EXTERNAL_LINKS.EXCLUDE.SECTION
text: PLUGINS.EXTERNAL_LINKS.EXCLUDE.SECTION_HELP
fields:
exclude.classes:
type: selectize
size: large
label: PLUGINS.EXTERNAL_LINKS.EXCLUDE.CLASSES
help: PLUGINS.EXTERNAL_LINKS.EXCLUDE.CLASSES_HELP
validate:
type: commalist
exclude.domains:
type: selectize
size: large
label: PLUGINS.EXTERNAL_LINKS.EXCLUDE.DOMAINS
help: PLUGINS.EXTERNAL_LINKS.EXCLUDE.DOMAINS_HELP
placeholder: 'localhost/*, img.domain.com/*'
validate:
type: commalist
content:
type: tab
title: PLUGINS.EXTERNAL_LINKS.CONTENT
fields:
process:
type: toggle
label: PLUGINS.EXTERNAL_LINKS.PROCESS
highlight: 1
default: 1
options:
1: PLUGIN_ADMIN.YES
0: PLUGIN_ADMIN.NO
validate:
type: bool
title:
type: toggle
label: PLUGINS.EXTERNAL_LINKS.TITLE
default: 0
options:
1: PLUGIN_ADMIN.YES
0: PLUGIN_ADMIN.NO
validate:
type: bool
no_follow:
type: toggle
label: PLUGINS.EXTERNAL_LINKS.NO_FOLLOW
default: 1
options:
1: PLUGIN_ADMIN.YES
0: PLUGIN_ADMIN.NO
validate:
type: bool
target:
type: select
size: large
label: PLUGINS.EXTERNAL_LINKS.TARGET
default: _blank
placeholder: _blank
selectize:
create: true
options:
_blank: PLUGINS.EXTERNAL_LINKS.TARGET_BLANK
_self: PLUGINS.EXTERNAL_LINKS.TARGET_SELF
_parent: PLUGINS.EXTERNAL_LINKS.TARGET_PARENT
_top: PLUGINS.EXTERNAL_LINKS.TARGET_TOP
validate:
type: string
mode:
type: select
size: large
classes: fancy
label: PLUGINS.EXTERNAL_LINKS.MODE
help: PLUGINS.EXTERNAL_LINKS.MODE_HELP
default: active
options:
active: PLUGINS.EXTERNAL_LINKS.MODE_ACTIVE
passive: PLUGINS.EXTERNAL_LINKS.MODE_PASSIVE
validate:
type: string

80
plugins/external_links/blueprints/external_links.yaml Normal file
View File

@ -0,0 +1,80 @@
form:
validation: loose
fields:
tabs:
type: tabs
active: 1
fields:
options:
type: tab
fields:
external_links:
type: section
title: PLUGINS.EXTERNAL_LINKS.PLUGIN_NAME
underline: true
fields:
header.external_links.process:
type: toggle
toggleable: true
label: PLUGINS.EXTERNAL_LINKS.PROCESS
highlight: 1
options:
1: PLUGIN_ADMIN.YES
0: PLUGIN_ADMIN.NO
validate:
type: bool
header.external_links.title:
type: toggle
toggleable: true
label: PLUGINS.EXTERNAL_LINKS.TITLE
options:
1: PLUGIN_ADMIN.YES
0: PLUGIN_ADMIN.NO
validate:
type: bool
header.external_links.no_follow:
type: toggle
toggleable: true
label: PLUGINS.EXTERNAL_LINKS.NO_FOLLOW
options:
1: PLUGIN_ADMIN.YES
0: PLUGIN_ADMIN.NO
validate:
type: bool
header.external_links.target:
type: select
size: large
toggleable: true
label: PLUGINS.EXTERNAL_LINKS.TARGET
'@config-default': plugins.external_links.target
placeholder: _blank
selectize:
create: true
options:
_blank: PLUGINS.EXTERNAL_LINKS.TARGET_BLANK
_self: PLUGINS.EXTERNAL_LINKS.TARGET_SELF
_parent: PLUGINS.EXTERNAL_LINKS.TARGET_PARENT
_top: PLUGINS.EXTERNAL_LINKS.TARGET_TOP
validate:
type: string
header.external_links.mode:
type: select
size: large
classes: fancy
toggleable: true
label: PLUGINS.EXTERNAL_LINKS.MODE
help: PLUGINS.EXTERNAL_LINKS.MODE_HELP
'@config-default': plugins.external_links.mode
options:
active: PLUGINS.EXTERNAL_LINKS.MODE_ACTIVE
passive: PLUGINS.EXTERNAL_LINKS.MODE_PASSIVE
validate:
type: string

505
plugins/external_links/classes/ExternalLinks.php Normal file
View File

@ -0,0 +1,505 @@
<?php
/**
* External Links
*
* This file is part of Grav External Links plugin.
*
* Dual licensed under the MIT or GPL Version 3 licenses, see LICENSE.
* http://benjamin-regler.de/license/
*/
namespace Grav\Plugin;
use Grav\Common\Utils;
use Grav\Common\Grav;
/**
* External Links
*
* Helper class to add small icons to external and mailto links, informing
* users the link will take them to a new site or open their email client.
*/
class ExternalLinks
{
/**
* @var ExternalLinks
*/
/** -------------
* Public methods
* --------------
*/
/**
* Process contents i.e. apply filer to the content.
*
* @param string $content The content to render.
* @param array $options Options to be passed to the renderer.
* @param null|Page $page Null or an instance of \Grav\Common\Page.
*
* @return string The rendered contents.
*/
public function render($content, $options = [], $page = null)
{
// Get all <a> tags and process them
$content = preg_replace_callback('~<a(?:\s[^>]*)?>.*?</a>~i',
function($match) use ($options, $page) {
// Load PHP built-in DOMDocument class
if (($dom = $this->loadDOMDocument($match[0])) === null) {
return $match[0];
}
// Check that there is really a link tag
$a = $dom->getElementsByTagName('a');
if ($a->length == 0) {
return $match[0];
}
$a = $a->item(0);
// Process links with non-empty href attribute
$href = $a->getAttribute('href');
if (strlen($href) == 0) {
return $match[0];
}
// Get the class of the <a> element
$class = $a->hasAttribute('class') ? $a->getAttribute('class') : '';
$classes = array_filter(explode(' ', $class));
// Exclude links with specific class from processing
$exclude = $options->get('exclude.classes', null);
if ($exclude && !!array_intersect($exclude, $classes)) {
return $match[0];
}
// Get domains to be seen as internal
$domains = $options->get('exclude.domains', []);
// This is a mailto link.
if (strpos($href, 'mailto:') === 0) {
$classes[] = 'mailto';
}
// The link is external
elseif ($url = $this->isExternalUrl($href, $domains, $page)) {
// Add external class
$classes[] = 'external-link';
$a->setAttribute('href', $url);
// Add target="_blank"
$target = $options->get('target');
if ($target) {
$a->setAttribute('target', $target);
}
// Add no-follow.
$nofollow = $options->get('no_follow');
if ($nofollow) {
$rel = array_filter(explode(' ', $a->getAttribute('rel')));
if (!in_array('nofollow', $rel)) {
$rel[] = 'nofollow';
$a->setAttribute('rel', implode(' ', $rel));
}
}
// Set rel="noopener noreferrer"
$rel = $a->hasAttribute('rel') ? $a->getAttribute('rel') : '';
$rel = array_filter(explode(' ', $rel));
$rel[] = 'noopener';
$rel[] = 'noreferrer';
$a->setAttribute('rel', implode(' ', array_unique($rel)));
// Add image class to <a> if it has at least one <img> child element
$imgs = $a->getElementsByTagName('img');
if ($imgs->length > 1) {
// Add "images" class to <a> element, if it has multiple child images
$classes[] = 'images';
} elseif ($imgs->length == 1) {
$imgNode = $imgs->item(0);
// Get image size
list($width, $height) = $this->getImageSize($imgNode);
// Determine maximum dimension of image size
$size = max($width, $height);
// Depending on size determine image type
$classes[] = ((0 < $size) && ($size <= 32)) ? 'icon' : 'image';
} else {
// Add "no-image" class to <a> element, if it has no child images
$classes[] = 'no-image';
}
// Add title (aka alert text)
if ($options->get('title')) {
$language = Grav::instance()['language'];
$message = $language->translate(['PLUGINS.EXTERNAL_LINKS.TITLE_MESSAGE']);
// Set default title to link else, set title as data attribute
$key = $a->hasAttribute('title') ? 'data-title' : 'title';
$a->setAttribute($key, $message);
}
}
// Set class attribute
if (count($classes) && ($options->get('mode') === 'active')) {
$a->setAttribute('class', implode(' ', $classes));
}
// Save Dom document back to HTML representation
$html = $this->saveDOMDocument($dom);
return $html;
}, $content);
// Write content back to page
return $content;
}
/** -------------------------------
* Private/protected helper methods
* --------------------------------
*/
/**
* Test if a URL is external
*
* @param string $url The URL to test.
* @param array $domains An array of domains to be seen as internal.
* @param null|Page $page Null or an instance of \Grav\Common\Page.
*
* @return mixed Returns the URL as a string, if it is external,
* false otherwise.
*/
protected function isExternalUrl($url, $domains = [], $page = null)
{
static $allowed_protocols;
static $pattern;
/** @var Config $config */
$config = Grav::instance()['config'];
/** @var Page $page */
$page = $page ?: Grav::instance()['page'];
// Statically store allowed protocols
if (!isset($allowed_protocols)) {
$allowed_protocols = array_flip(
$config->get('plugins.external_links.links.schemes', ['http', 'https'])
);
}
// Statically store internal domains as a PCRE pattern.
if (!isset($pattern) || (count($domains) > 0)) {
$domains = array_merge($domains,
array(Grav::instance()['base_url_absolute']));
foreach ($domains as $domain) {
$domains[] = preg_quote($domain, '#');
}
$pattern = '#(' . str_replace(array('\*', '/*'), '.*?',
implode('|', $domains)) . ')#i';
}
$external = false;
// Check for URLs that don't match any excluded domain
if (!preg_match($pattern, $url)) {
// Check if URL is external by extracting colon position
$colonpos = strpos($url, ':');
if ($colonpos > 0) {
// We found a colon, possibly a protocol. Verify.
$protocol = strtolower(substr($url, 0, $colonpos));
if (isset($allowed_protocols[$protocol])) {
// The protocol turns out be an allowed protocol
$external = $url;
}
} else {
if ($config->get('plugins.external_links.links.www')) {
// Remove possible path duplicate
$route = Grav::instance()['base_url'] . $page->route();
$href = Utils::startsWith($url, $route)
? ltrim(mb_substr($url, mb_strlen($route)), '/')
: $url;
// We found an url without protocol, but with starting 'www' (sub-)domain
if (Utils::startsWith($url, 'www.')) {
$external = 'http://' . $url;
} elseif (Utils::startsWith($href, 'www.')) {
$external = 'http://' . $href;
}
}
if ($config->get('plugins.external_links.links.redirects')) {
$targetPage = Grav::instance()['pages']->find($url);
if ($targetPage && $targetPage->redirect()) {
$external = $this->isExternalUrl($targetPage->redirect(), $domains, $page);
}
}
}
}
// Only if a valid protocol or an URL starting with 'www.' was found return true
return $external;
}
/**
* Determine the size of an image
*
* @param DOMNode $imgNode The image already parsed as a DOMNode
* @param integer $limit Load first $limit KB of remote image
*
* @return array Return the dimension of the image of the
* format array(width, height)
*/
protected function getImageSize($imgNode, $limit = 32)
{
// Hold units (assume standard font with 16px base pixel size)
// Calculations based on pixels
$units = array(
'px' => 1, /* base unit: pixel */
'pt' => 16 / 12, /* 12 point = 16 pixel = 1/72 inch */
'pc' => 16, /* 1 pica = 16 pixel = 12 points */
'in' => 96, /* 1 inch = 96 pixel = 2.54 centimeters */
'mm' => 96 / 25.4, /* 1 millimeter = 96 pixel / 1 inch [mm] */
'cm' => 96 / 2.54, /* 1 centimeter = 96 pixel / 1 inch [cm] */
'm' => 96 / 0.0254, /* 1 centimeter = 96 pixel / 1 inch [m] */
'ex' => 7, /* 1 ex = 7 pixel */
'em' => 16, /* 1 em = 16 pixel */
'rem' => 16, /* 1 rem = 16 pixel */
'%' => 16 / 100, /* 100 percent = 16 pixel */
);
// Initialize dimensions
$width = 0;
$height = 0;
// Determine image dimensions based on "src" atrribute
if ($imgNode->hasAttribute('src')) {
$src = $imgNode->getAttribute('src');
// Simple check if the URL is internal i.e. check if path exists
$path = $_SERVER['DOCUMENT_ROOT'] . $src;
if (realpath($path) && is_file($path)) {
$size = @getimagesize($path);
} else {
// The URL is external; try to load it (default: 32 KB)
$size = $this->getRemoteImageSize($src, $limit * 1024);
}
}
// Read out width and height from <img> attributes
$width = $imgNode->hasAttribute('width') ?
$imgNode->getAttribute('width') : $size[0];
$height = $imgNode->hasAttribute('height') ?
$imgNode->getAttribute('height') : $size[1];
// Get width and height from style attribute
if ( $imgNode->hasAttribute('style') ) {
$style = $imgNode->getAttribute('style');
// Width
if (preg_match('~width:\s*(\d+)([a-z]+)~i', $style, $matches)) {
$width = $matches[1];
// Convert unit to pixel
if ( isset($units[$matches[2]]) ) {
$width *= $units[$matches[2]];
}
}
// Height
if (preg_match('~height:\s*(\d+)([a-z]+)~i', $style, $matches)) {
$height = $matches[1];
// Convert unit to pixel
if (isset($units[$matches[2]])) {
$height *= $units[$matches[2]];
}
}
}
// Update width and height
$size[0] = $width;
$size[1] = $height;
// Return image dimensions
return $size;
}
/**
* Get the size of a remote image
*
* @param string $uri The URI of the remote image
* @param integer $limit Load first $limit bytes of remote image
*
* @return mixed Returns an array with up to 7 elements
*/
protected function getRemoteImageSize($uri, $limit = -1)
{
// Create temporary file to store data from $uri
$tmp_name = tempnam(sys_get_temp_dir(), uniqid('ris'));
if ($tmp_name === false) {
return false;
}
// Open temporary file
$tmp = fopen($tmp_name, 'wb');
// Check which method we should use to get remote image sizes
$allow_url_fopen = ini_get('allow_url_fopen') ? true : false;
$use_curl = function_exists('curl_version');
// Use stream copy
if ($allow_url_fopen) {
$options = [];
if ( $limit > 0 ) {
// Loading number of $limit bytes
$options['http']['header'] = array('Range: bytes=0-' . $limit);
}
// Create stream context
$context = stream_context_create($options);
@copy($uri, $tmp_name, $context);
// Use Curl
} elseif ($use_curl) {
// Initialize Curl
$options = array(
CURLOPT_HEADER => false, // Don't return headers
CURLOPT_FOLLOWLOCATION => true, // Follow redirects
CURLOPT_AUTOREFERER => true, // Set referrer on redirect
CURLOPT_CONNECTTIMEOUT => 120, // Timeout on connect
CURLOPT_TIMEOUT => 120, // Timeout on response
CURLOPT_MAXREDIRS => 10, // Stop after 10 redirects
CURLOPT_ENCODING => '', // Handle all encodings
CURLOPT_BINARYTRANSFER => true, // Transfer as binary file
CURLOPT_FILE => $tmp, // Curl file
CURLOPT_URL => $uri, // URI
);
$curl = curl_init();
curl_setopt_array($curl, $options);
if ($limit > 0) {
// Loading number of $limit
$headers = array('Range: bytes=0-' . $limit);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RANGE, '0-' . $limit);
// Abort request when more data is received
curl_setopt($curl, CURLOPT_BUFFERSIZE, 512); // More progress info
curl_setopt($curl, CURLOPT_NOPROGRESS, false); // Monitor progress
curl_setopt($curl, CURLOPT_PROGRESSFUNCTION,
function($download_size, $downloaded, $upload_size, $uploaded) use ($limit) {
// If $downloaded exceeds $limit, returning non-zero breaks
// the connection!
return ( $downloaded > $limit ) ? 1 : 0;
});
}
// Execute Curl
curl_exec($curl);
curl_close($curl);
}
// Close temporary file
fclose($tmp);
// Retrieve image information
$info = array(0, 0, 'width="0" height="0"');
if (filesize($tmp_name) > 0) {
$info = @getimagesize($tmp_name);
}
// Delete temporary file
unlink($tmp_name);
return $info;
}
/**
* Load contents into PHP built-in DOMDocument object
*
* Two Really good resources to handle DOMDocument with HTML(5)
* correctly.
*
* @see http://stackoverflow.com/questions/3577641/how-do-you-parse-and-process-html-xml-in-php
* @see http://stackoverflow.com/questions/7997936/how-do-you-format-dom-structures-in-php
*
* @param string $content The content to be loaded into the
* DOMDocument object
*
* @return DOMDocument DOMDocument object of content
*/
protected function loadDOMDocument($content)
{
// Clear previous errors
if (libxml_use_internal_errors(true) === true) {
libxml_clear_errors();
}
// Parse content using PHP built-in DOMDocument class
$document = new \DOMDocument('1.0', 'UTF-8');
// Encode contents as UTF-8, strip whitespaces & normalize newlines
$content = mb_convert_encoding($content, 'HTML-ENTITIES', 'UTF-8');
// $whitespaces = array(
// '~\R~u' => "\n", // Normalize new line
// '~\>[^\S ]+~s' => '>', // Strip whitespaces after tags, except space
// '~[^\S ]+\<~s' => '<', // Strip whitespaces before tags, except space
// '~(\s)+~s' => '\\1' // Shorten multiple whitespace sequences
// );
// $content = preg_replace(array_keys($whitespaces), $whitespaces, $content);
// Parse the HTML using UTF-8
// The @ before the method call suppresses any warnings that
// loadHTML might throw because of invalid HTML in the page.
@$document->loadHTML($content);
// Do nothing, if DOM is empty
if (is_null($document->documentElement)) {
return null;
}
return $document;
}
/**
* Save contents of PHP built-in DOMDocument object as HTML5
*
* @param DOMDocument $document DOMDocument object with nodes
*
* @return string The outputted DOM document as HTML(5)
* compliant string
*/
protected function saveDOMDocument($document)
{
// Pretty print output
$document->preserveWhiteSpace = false;
$document->formatOutput = true;
// Transform DOM document to valid HTML(5)
$content = '';
$body = $document->getElementsByTagName('body')->item(0);
foreach ($body->childNodes as $node) {
// Expand empty tags (e.g. <br/> to <br></br>)
if (($html = $document->saveXML($node, LIBXML_NOEMPTYTAG)) !== false) {
$content .= $html;
}
}
// Fix formatting for self-closing tags in HTML5 and removing
// encapsulated (uncommented) CDATA blocks in <script> and
// <style> tags
$regex = array(
'~' . preg_quote('<![CDATA[', '~') . '~' => '',
'~' . preg_quote(']]>', '~') . '~' => '',
'~></(?:area|base(?:font)?|br|col|command|embed|frame|hr|img|input|keygen|link|meta|param|source|track|wbr)>~' => ' />',
);
// Make XML HTML5 compliant
$content = preg_replace(array_keys($regex), $regex, $content);
return $content;
}
}

125
plugins/external_links/docs/CONTRIBUTING.md Normal file
View File

@ -0,0 +1,125 @@
# Contributing to Grav External Links plugin
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
## Using the issue tracker
The issue tracker is the preferred channel for [bug reports](#bugs), [features requests](#features) and [submitting pull requests](#pull-requests), but please respect the following restrictions:
* Please format your issue using [GitHub's markdown syntax and features][markdown].
* Please **do not** use the issue tracker for personal support requests (use [Stack Overflow](http://stackoverflow.com) or IRC).
* Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.
As a courtesy to avoid sending notifications to any user that might have the `@username` being referenced, please remember that GitHub usernames also start with the at sign and therefore wrap words that begin with the at sign (`@`) in backticks.
<a id="bugs"></a>
## Bug reports
A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
1. **Use the GitHub issue search** &mdash; check if the issue has already been reported.
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `master` or development branch in the repository.
3. **Isolate the problem** &mdash; create a [reduced test case](http://css-tricks.com/6263-reduced-test-cases/) and a live example that should be included in each bug report.
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
_Example:_
> Short and descriptive example bug report title
>
> A summary of the issue and the browser/OS environment in which it occurs. If
> suitable, include the steps required to reproduce the bug.
>
> 1. This is the first step
> 2. This is the second step
> 3. Further steps, etc.
>
> `<url>` - a link to the reduced test case
>
> Any other information you want to share that is relevant to the issue being
> reported. This might include the lines of code that you have identified as
> causing the bug, and potential solutions (and your opinions on their
> merits).
Last but not least, if you have a solution or suggestion for how to fix the bug you're reporting, please include it, too, or make a pull request - this will make the life of the maintainers easier and a bug faster to be fixed.
<a id="features"></a>
## Feature requests
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible and don't forget:
* Please search for existing feature requests first to see if something similar already exists.
* Include a clear and specific use-case. We love new ideas, but we do not add features without a reason.
* Consider whether or not your feature would be better as a function or implemented in a separate project.
## Pull requests
Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. You can start by adding a feature request to get feedback and see how your idea is received.
**Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).
Follow this process if you'd like your work considered for inclusion in the project:
1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:
```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/<repo-name>
# Navigate to the newly cloned directory
cd <repo-name>
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/<upstream-owner>/<repo-name>
```
2. If you cloned a while ago, get the latest changes from upstream:
```bash
git checkout <dev-branch>
git pull upstream <dev-branch>
```
3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
```bash
git checkout -b <topic-branch-name>
```
4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) or your code is unlikely be merged into the main project. Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) feature to tidy up your commits before making them public.
5. Locally merge (or rebase) the upstream development branch into your topic branch:
```bash
git pull [--rebase] upstream <dev-branch>
```
6. Push your topic branch up to your fork:
```bash
git push origin <topic-branch-name>
```
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description.
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
license your work under the same license as that used by the project.
### Coding Standards
* Always use spaces, never tabs
* End lines in semi-colons.
## Developing
If you want to take an issue, just add a small comment saying you are having a go at something, so we don't get duplication.
[markdown]: https://help.github.com/articles/github-flavored-markdown

47
plugins/external_links/docs/INSTALL.md Normal file
View File

@ -0,0 +1,47 @@
# [Installation and update guide][project]
[project]: https://github.com/sommerregen/grav-plugin-external-links
## Installation
Installing the `External Links` plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
### GPM Installation (Preferred)
The simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's Terminal (also called the command line). From the root of your Grav install type:
bin/gpm install external_links
This will install the `External Links` plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/external_links`.
### Manual Installation
To install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `external_links`. You can find these files either on [GitHub](https://github.com/sommerregen/grav-plugin-external-links) or via [GetGrav.org](http://getgrav.org/downloads/plugins).
You should now have all the plugin files under
/your/site/grav/user/plugins/external_links
>> NOTE: This plugin is a modular component for Grav which requires [Grav](http://github.com/getgrav/grav) and a theme to be installed in order to operate.
## Updating
As development for `External Links` continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating `External Links` is easy, and can be done through Grav's GPM system, as well as manually.
### GPM Update (Preferred)
The simplest way to update this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:
bin/gpm update external_links
This command will check your Grav install to see if your `External Links` plugin is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type `y` and hit enter. The plugin will automatically update and clear Grav's cache.
#### Manual Update
Manually updating `External Links` is pretty simple. Here is what you will need to do to get this done:
* Delete the `your/site/user/plugins/external_links` directory.
* Download the new version of the `External Links` plugin from either [GitHub](https://github.com/sommerregen/grav-plugin-external-links) or [GetGrav.org](http://getgrav.org/downloads/plugins).
* Unzip the zip file in `your/site/user/plugins` and rename the resulting folder to `external_links`.
* Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing `bin/grav clear-cache`.
>> Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in `user/config/plugins`) will remain intact.

221
plugins/external_links/external_links.php Normal file
View File

@ -0,0 +1,221 @@
<?php
/**
* External Links v1.6.1
*
* This plugin adds small icons to external and mailto links, informing
* users the link will take them to a new site or open their email client.
*
* Dual licensed under the MIT or GPL Version 3 licenses, see LICENSE.
* http://benjamin-regler.de/license/
*
* @package External Links
* @version 1.6.1
* @link <https://github.com/sommerregen/grav-plugin-external-links>
* @author Benjamin Regler <sommerregen@benjamin-regler.de>
* @copyright 2017+, Benjamin Regler
* @license <http://opensource.org/licenses/MIT> MIT
* @license <http://opensource.org/licenses/GPL-3.0> GPLv3
*/
namespace Grav\Plugin;
use Grav\Common\Plugin;
use Grav\Common\Page\Interfaces\PageInterface;
use Grav\Common\Data\Blueprints;
use RocketTheme\Toolbox\Event\Event;
/**
* External Links Plugin
*
* This plugin adds small icons to external and mailto links, informing
* users the link will take them to a new site or open their email client.
*/
class ExternalLinksPlugin extends Plugin
{
/**
* @var ExternaLinksPlugin
*/
/**
* Instance of ExternalLinks class
*
* @var \Grav\Plugin\ExternalLinks
*/
protected $external_links;
/** -------------
* Public methods
* --------------
*/
/**
* Return a list of subscribed events.
*
* @return array The list of events of the plugin of the form
* 'name' => ['method_name', priority].
*/
public static function getSubscribedEvents()
{
return [
'onPluginsInitialized' => ['onPluginsInitialized', 0]
];
}
/**
* Initialize configuration
*/
public function onPluginsInitialized()
{
// Process contents order according to weight option
$weight = $this->config->get('plugins.external_links.weight', 0);
// Set default events
$events = [
'onTwigInitialized' => ['onTwigInitialized', 0],
'onTwigSiteVariables' => ['onTwigSiteVariables', 0],
'onPageContentProcessed' => ['onPageContentProcessed', $weight]
];
// Set admin specific events
if ($this->isAdmin()) {
$this->active = false;
$events = [
'onBlueprintCreated' => ['onBlueprintCreated', 0]
];
}
// Register events
$this->enable($events);
}
/**
* Extend page blueprints with ExternalLinks configuration options.
*
* @param Event $event
*/
public function onBlueprintCreated(Event $event)
{
/** @var Blueprints $blueprint */
$blueprint = $event['blueprint'];
if ($blueprint->get('form/fields/tabs', null, '/')) {
$blueprints = new Blueprints(__DIR__ . '/blueprints/');
$extends = $blueprints->get($this->name);
$blueprint->extend($extends, true);
}
}
/**
* Apply external links filter to content, when each page has not been
* cached yet.
*
* @param Event $event The event when 'onPageContentProcessed' was
* fired.
*/
public function onPageContentProcessed(Event $event)
{
/** @var Page $page */
$page = $event['page'];
$config = $this->mergeConfig($page);
$enabled = ($config->get('process') && $config->get('enabled')) ? true : false;
if ($enabled && $this->compileOnce($page)) {
// Do nothing, if a route for a given page does not exist and check if
// mode option is valid
$mode = strtolower($config->get('mode', 'passive'));
if (!$page->route() || !in_array($mode, array('active', 'passive'))) {
return;
}
// Get content and list of exclude tags
$content = $page->getRawContent();
// Apply external links filter and save modified page content
$page->setRawContent(
$this->externalLinksFilter($content, $config->toArray(), $page)
);
}
}
/**
* Initialize Twig configuration and filters.
*/
public function onTwigInitialized()
{
// Expose function
$this->grav['twig']->twig()->addFilter(
new \Twig_SimpleFilter('external_links', [$this, 'externalLinksFilter'], ['is_safe' => ['html']])
);
}
/**
* Set needed variables to display external links.
*/
public function onTwigSiteVariables()
{
if ($this->config->get('plugins.external_links.built_in_css')) {
$this->grav['assets']->add('plugin://external_links/assets/css/external_links.css');
}
}
/**
* Filter to parse external links.
*
* @param string $content The content to be filtered.
* @param array $options Array of options for the External links filter.
*
* @return string The filtered content.
*/
public function externalLinksFilter($content, $params = [])
{
// Get custom user configuration
$page = func_num_args() > 2 ? func_get_arg(2) : $this->grav['page'];
$config = $this->mergeConfig($page, true, $params);
// Render
return $this->init()->render($content, $config, $page);
}
/** -------------------------------
* Private/protected helper methods
* --------------------------------
*/
/**
* Checks if a page has already been compiled yet.
*
* @param Page $page The page to check
* @return boolean Returns true if page has already been
* compiled yet, false otherwise
*/
protected function compileOnce(PageInterface $page)
{
static $processed = [];
$id = md5($page->path());
// Make sure that contents is only processed once
if (!isset($processed[$id]) || ($processed[$id] < $page->modified())) {
$processed[$id] = $page->modified();
return true;
}
return false;
}
/**
* Initialize plugin and all dependencies.
*
* @return \Grav\Plugin\ExternalLinks Returns ExternalLinks instance.
*/
protected function init()
{
if (!$this->external_links) {
// Initialize ExternalLinks instance
require_once(__DIR__ . '/classes/ExternalLinks.php');
$this->external_links = new ExternalLinks();
}
return $this->external_links;
}
}

43
plugins/external_links/external_links.yaml Normal file
View File

@ -0,0 +1,43 @@
# Global plugin configurations
enabled: true # Set to false to disable this plugin completely
built_in_css: true # Use built-in CSS of the plugin
weight: 0 # Set the weight (order of execution)
# Default options for External Links configuration
exclude:
classes: [exclude] # Exclude all links with this class
domains: # A list of domains to be excluded e.g
# - localhost/* # (any RegExp can be used)
# - img.domain.com/*
links:
www: false # Autom. link any hostname that starts with "www."
redirects: false # Also mark links as external, that link to pages that redirect to an external URL
schemes: # Allowed schemes
- 'http'
- 'https'
- 'ftp'
- 'irc'
- 'mailto'
- 'news'
- 'nntp'
- 'rtsp'
- 'sftp'
- 'ssh'
- 'tel'
- 'telnet'
- 'webcal'
# Global and page specific configurations
process: true # Filter external links
title: false # Sets default title for external links
no_follow: true # Add rel="nofollow" to all external links
target: "_blank" # Set target attribute of link
mode: "active" # active = process and parse all links;
# passive = parse links, but don't set CSS classes

215
plugins/external_links/languages.yaml Normal file
View File

@ -0,0 +1,215 @@
# German
de:
PLUGINS:
EXTERNAL_LINKS:
PLUGIN_NAME: "External Links"
PLUGIN_STATUS: "Plugin Status"
PLUGIN_STATUS_HELP: "Aktiviere das Plugin oder schalte es komplett ab."
BUILTIN_CSS: "Verwende mitgeliefertes CSS"
WEIGHT: "Ausführungsreihenfolge"
SETTINGS: "Einstellungen"
CONTENT: "Inhalt"
EXCLUDE:
SECTION: "Ausnahmen"
SECTION_HELP: "Setzt Links mit bestimmten Klassen oder Links von bestimmten Domains immer als intern."
CLASSES: "Ignoriere Links mit diesen Klassen"
CLASSES_HELP: "Komma getrennte Liste"
DOMAINS: "Eine Liste von auszuschließenden Domains"
DOMAINS_HELP: "Komma getrennte Liste von Domains z.B. _localhost/*_ (jeder regulärer Ausdruck kann verwendet werden)"
LINKS:
SECTION: "Links"
SECTION_HELP: "Sieht Links beginnend mit <code>www.</code> oder mit als extern markierten Protokollen als extern an."
WWW: "Verlinkung (WWW)"
WWW_HELP: "Verlinke auch Links, die mit 'www.' beginnen als extern"
REDIRECTS: "Folge Seiten-Weiterleitungen"
REDIRECTS_HELP: "Links zu Seiten, die zu einer externen URL weiterleiten werden auch als extern markiert"
SCHEMES: "Erlaubte Protokolle"
SCHEMES_HELP: "Liste von erlaubten Protokollen"
PROCESS: "Aktiviere <code>External Links</code> auf Seite"
TITLE: "Zeige Standardtexttitel für externe Links"
TITLE_MESSAGE: "Dieser Link führt auf eine externe Webseite für deren Inhalt wir nicht verantwortlich sind."
NO_FOLLOW: 'Fügt <code>rel="nofollow"</code> zu allen externen Links'
TARGET: 'Setze "target" Attribut des Links.'
TARGET_BLANK: "_blank - Öffne Link im neuen Fenster"
TARGET_SELF: "_self - Öffne Link im gleichen Tab oder Seite"
TARGET_PARENT: "_parent - Öffne Link im Elternfenster"
TARGET_TOP: "_top - Öffne Link im ganzen Fenster"
MODE: "Modus"
MODE_HELP: "active = Zeichne externe Links aus; passive = Zeichne externe Links aus ohne entsprechende CSS-Klassen zu setzen"
MODE_ACTIVE: "Aktiv - Zeichne externe Links aus"
MODE_PASSIVE: "Passiv - Zeichne externe Links aus ohne entsprechende CSS-Klassen zu setzen"
# English
en:
PLUGINS:
EXTERNAL_LINKS:
PLUGIN_NAME: "External Links"
PLUGIN_STATUS: "Plugin status"
STATUS_HELP: "Set to false to disable this plugin completely."
BUILTIN_CSS: "Use built in CSS"
WEIGHT: "Order of execution"
SETTINGS: "Settings"
CONTENT: "Content"
EXCLUDE:
SECTION: "Exclusion"
SECTION_HELP: "Exclude links with a specific class or domains from being recognized as external links."
CLASSES: "Exclude all links with this class"
CLASSES_HELP: "Comma separated list."
DOMAINS: "A list of domains to be excluded"
DOMAINS_HELP: "Comma separated list of domains e.g. _localhost/*_ (any regular expression can be used)"
LINKS:
SECTION: "Links"
SECTION_HELP: "Set links starting with <code>www.</code> and within the list of allowed schemes as external."
WWW: "Link WWW"
WWW_HELP: "Automatically link any hostname that starts with 'www.' as external"
REDIRECTS: "Follow Page redirects"
REDIRECTS_HELP: "Also mark links as external, that link to pages that redirect to an external URL"
SCHEMES: "Allowed schemes"
SCHEMES_HELP: "List of allowed schemes"
PROCESS: "Filter external links on the page"
TITLE: "Show default title for external links"
TITLE_MESSAGE: "This link will take you to an external web site. We are not responsible for their content."
NO_FOLLOW: 'Add <code>rel="nofollow"</code> to all external links'
TARGET: "Set target attribute of the link."
TARGET_BLANK: "_blank | Load in a new window"
TARGET_SELF: "_self | Load in the same frame as it was clicked"
TARGET_PARENT: "_parent | Load in the parent frameset"
TARGET_TOP: "_top | Load in the full body of the window"
MODE: "Mode"
MODE_HELP: "active = process and parse all links; passive = parse links, but don't set CSS classes"
MODE_ACTIVE: "Active - Process and parse all links"
MODE_PASSIVE: "Passive - Parse links, but don't set CSS classes"
# French
fr:
PLUGINS:
EXTERNAL_LINKS:
PLUGIN_NAME: "Liens externes"
PLUGIN_STATUS: "Statut du plugin"
STATUS_HELP: "Régler sur false pour désactiver complètement le plugin."
BUILTIN_CSS: "Utiliser les CSS intégrés"
WEIGHT: "Ordre d’exécution"
SETTINGS: "Configuration"
CONTENT: "Contenu"
EXCLUDE:
SECTION: "Exclusion"
SECTION_HELP: "Exclure les liens avec des classes spécifiques ou des domaines comme étant reconnus comme liens externes."
CLASSES: "Exclure tous les liens avec cette classe"
CLASSES_HELP: "Liste des classes séparées par des virgules."
DOMAINS: "Une liste des domaines à exclure"
DOMAINS_HELP: "Liste des domaines séparés par des virgules ex : _localhost/*_ (les expressions régulières peuvent être utilisées)"
LINKS:
SECTION: "Liens"
SECTION_HELP: "Définir les liens commençant par <code>www.</code> et ceux de la liste des schémas définis comme étant des liens externes."
WWW: "Liens WWW"
WWW_HELP: "Reconnaître automatiquement tout lien commencant par 'www.' comme étant un lien externe."
REDIRECTS: "Follow Page redirects"
REDIRECTS_HELP: "Also mark links as external, that link to pages that redirect to an external URL"
SCHEMES: "Schémas autorisés"
SCHEMES_HELP: "Liste des schémas autorisés"
PROCESS: "Filtrer les liens externes de la page"
TITLE: "Afficher le titre par défaut pour les liens externes"
TITLE_MESSAGE: "Ce lien va vous diriger vers un site externe. Nous ne sommes pas responsables de son contenu."
NO_FOLLOW: 'Ajouter <code>rel="nofollow"</code> à tous les liens externes'
TARGET: "Spécifier la cible dans laquelle le contenu du lien doit s'afficher."
TARGET_BLANK: "_blank | Afficher dans une nouvelle fenêtre"
TARGET_SELF: "_self | Afficher dans la même fenêtre"
TARGET_PARENT: "_parent | Afficher dans le cadre parent (frame)"
TARGET_TOP: "_top | Afficher dans le cadre racine"
MODE: "Mode"
MODE_HELP: "actif = analyser et procéder pour tous les liens; passif = analyser les liens mais ne pas appliquer les classes CSS"
MODE_ACTIVE: "Actif - Analyser et procéder pour tous les liens"
MODE_PASSIVE: "Passif - Analyser les liens mais ne pas appliquer les classes CSS"
# Russian
ru:
PLUGINS:
EXTERNAL_LINKS:
PLUGIN_NAME: "Внешние ссылки"
PLUGIN_STATUS: "Статус плагина"
STATUS_HELP: "Установите нет, чтобы отключить этот плагин полностью."
BUILTIN_CSS: "Использовать встроенные CSS"
WEIGHT: "Порядок выполнения"
SETTINGS: "Настройки"
CONTENT: "Контент"
EXCLUDE:
SECTION: "Исключения"
SECTION_HELP: "Исключить ссылки с определенным классом или домены, которые не признаются в качестве внешних ссылок."
CLASSES: "Исключить все ссылки с этим классом"
CLASSES_HELP: "Список разделенных запятыми."
DOMAINS: "Список доменов, которые будут исключены"
DOMAINS_HELP: "Разделенный запятыми список доменов, например, _localhost / * _ (любое регулярное выражение может быть использовано)"
LINKS:
SECTION: "Ссылки"
SECTION_HELP: "Установить ссылки, начинающиеся с <code>www.</code>? и список разрешенных схем, как внешние."
WWW: "Ссылка WWW"
WWW_HELP: "Автоматически связывать любое имя хоста, которое начинается с 'www'. как внешние"
REDIRECTS: "Follow Page redirects"
REDIRECTS_HELP: "Also mark links as external, that link to pages that redirect to an external URL"
SCHEMES: "Допустимые схемы"
SCHEMES_HELP: "Список допустимых схем"
PROCESS: "Фильтр внешних ссылок на странице"
TITLE: "Показать название по умолчанию для внешних ссылок"
TITLE_MESSAGE: "Эта ссылка приведет вас на внешний веб-сайт. Мы не несем ответственности за его содержание."
NO_FOLLOW: 'Добавить <code>rel="nofollow"</code> ко всем внешним ссылкам'
TARGET: "Установить целевой атрибут ссылки."
TARGET_BLANK: "_blank | Загрузка в новом окне"
TARGET_SELF: "_self | Загрузка в том же фрейме где и был сделан клик"
TARGET_PARENT: "_parent | Загрузка в родительском наборе фреймов"
TARGET_TOP: "_top | Загрузка в отдельном окне браузера"
MODE: "Режим"
MODE_HELP: "активный = обработка и разбор всех ссылок; пассивный = вставлять ссылки, но не устанавливать для них CSS"
MODE_ACTIVE: "Активный = обработка и разбор всех ссылок"
MODE_PASSIVE: "Пассивный = вставлять ссылки, но не устанавливать для них CSS"