[V3] Big Crunch

And so, just as it begins, so too must it end One should not dwell and stall, for more is to come
1 year ago · 11154a0d8c
--- a/.gitignore
+++ b/.gitignore
@@ -1,19 +0,0 @@
 avatar/
 files/
 file/
 local/
 logs/
 log/
 run/
 config.php
 .htaccess
 httpd.conf
 dataobject.ini
 *.bak
 *.orig
 *.rej
 TODO.rym
 config-*.php
 good-config.php
 *.mo
 /vendor/
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,109 +0,0 @@
 # GNU social - Log of Changes

 ## 2.0.0 - THIS. IS. GNU SOCIAL!!! [WIP]

 Release name chosen after 300 by Frank Miller where the main protagonist Leonidas, King of Sparta, declines peace with the
 Persians, after being disrespected, by shouting at the Persian Messenger "This is Sparta!" and kicking him into a large well
 proceeded by the killing of the other Persian messengers.

 ### Major changes from previous release:

 Load and Storage:
 - New media handling system
 - GS is now structurely divided in includes and public
 - OEmbed upgraded to Embed plugin (Now we provide Open Graph information too)
 - Added Redis based caching and queues
 - Improved memcached support

 Federation:
 - Added ActivityPub support
 - RemoteFollow: Remote follow ActivityPub and OStatus remote actors via the click of a button
 - ActorLists: Allow to create collections of Actors and to interact with them - supports both OStatus and ActivityPub
 - The Free Network: Automagically migrate internal remote profiles between Free Network protocols
 - Enabled the search box to import remote notices and profiles
 - Improvements on Nodeinfo (and new route)

 General:
 - Composer was integrated

 Modules:
 - Restored built-in plugins
 - New modules system: core plugins and plugins physically separated
 - Bug fixes of core modules logic
 - Improved plugin management tool (now all available plugins are shown and third party can be uploaded and deleted)

 ## v1.20.9release - The Invicta Crusade

 Dropped Support for PHP5.6.x. Minimum PHP version now is 7.0.0.

 Release name chosen after Porto city. Porto is one of the oldest cities in Europe and thanks to its fierce resistance during
 two battles and sieges in history, it has earned the epithet of ‘Cidade Invicta’ (Invincible City). The dev team behind this
 release studies in Porto, Portugal.

 Major changes from previous release:

 - Various patches on PEAR related components
 - Various database related improvements
 - Improved XMPP support
 - Added Nodeinfo support
 - Various i18n and l10n bug fixes
 - Improvements on Internal Session Handler
 - Improvements on OpenID support
 - Improved Media handling and safer upload
 - Redirect to previous page after login
 - Initial work on full conversion to PHP7
 - Initial work on a better documentation
 - Allow login with email
 - Various bug fixes

 ## v1.2.0beta4 - The good reign of PHP5

 Dropped support for PHP5.4.

 New this version

 This is the development branch for the 1.2.x version of GNU social. All daring 1.1.x admins should upgrade to this version.

 So far it includes the following changes:

 - Backing up a user's account is more and more complete.
 - Emojis 😸 (utf8mb4 support)

 The last release, 1.1.3, gave us these improvements:

 - XSS security fix (thanks Simon Waters, https://www.surevine.com/)
 - Many improvements to ease adoption of the Qvitter front-end https://github.com/hannesmannerheim/qvitter
 - Protocol adaptions for improved performance and stability

 Upgrades from StatusNet 1.1.1 will also experience these improvements:

 - Fixes for SQL injection errors in profile lists.
 - Improved ActivityStreams JSON representation of activities and objects.
 - Upgrade to the Twitter 1.1 API.
 - More robust handling of errors in distribution.
 - Fix error in OStatus subscription for remote groups.
 - Fix error in XMPP distribution.
 - Tracking of conversation URI metadata (more coherent convos)

 ## v1.1.3release - The Spanish Invasion

 New this version

 This is a security fix and bug fix release since 1.1.3-beta2. All 1.1.x sites should upgrade to this version.

 So far it includes the following changes:

 - XSS security fix (thanks Simon Waters, https://www.surevine.com/)
 - Many improvements to ease adoption of the Qvitter front-end https://github.com/hannesmannerheim/qvitter
 - Protocol adaptions for improved performance and stability
 - Backing up a user's account now appears to work as it should

 Upgrades from StatusNet 1.1.1 will also experience these improvements:

 - Fixes for SQL injection errors in profile lists.
 - Improved ActivityStreams JSON representation of activities and objects.
 - Upgrade to the Twitter 1.1 API.
 - More robust handling of errors in distribution.
 - Fix error in OStatus subscription for remote groups.
 - Fix error in XMPP distribution.
 - Tracking of conversation URI metadata (more coherent convos)
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -1,95 +0,0 @@
 ## Code of Conduct

 ### Our Pledge

 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
 size, disability, ethnicity, gender identity and expression, level of experience,
 nationality, personal appearance, race, religion, or sexual identity and
 orientation.

 ### Our Standards

 Examples of behavior that contributes to creating a positive environment
 include:

 * Using welcoming and inclusive language
 * Being respectful of differing viewpoints and experiences
 * Gracefully accepting constructive criticism
 * Focusing on what is best for the community
 * Showing empathy towards other community members

 Examples of unacceptable behavior by participants include:

 * The use of sexualized language or imagery and unwelcome sexual attention or
 advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
  address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
  professional setting

 ### Our Responsibilities

 Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
 response to any instances of unacceptable behavior.

 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
 that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.

 ### Scope

 This Code of Conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community. Examples of
 representing a project or community include using an official project e-mail
 address, posting via an official social media account, or acting as an appointed
 representative at an online or offline event. Representation of a project may be
 further defined and clarified by project maintainers.

 ### Enforcement

 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting the project team at mattl@gnu.org. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
 Further details of specific enforcement policies may be posted separately.

 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
 members of the project's leadership.

 ### Attribution

 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
 available at [http://contributor-covenant.org/version/1/4][version]

 [homepage]: http://contributor-covenant.org
 [version]: http://contributor-covenant.org/version/1/4/


 ## The Code of Conflict

 GNU social has a high submission standard and we want to keep quality code in the
 codebase and bad code out of it. As such your code will be closely scrutinized,
 and you might take this criticism personally. Please understand that this is
 meant to keep the standards of the codebase up, and isn't meant personally. All
 the same, this isn't an excuse for poor behaviour, and a reviewer shouldn't be
 misbehaving towards submitters.


 If however, anyone feels personally abused, threatened, or otherwise
 uncomfortable due to this process, that is not acceptable.  If so, please
 contact the project team at mattl@gnu.org, and they will work to resolve the issue
 to the best of their ability.

 As a reviewer of code, please strive to keep things civil and focused on the
 technical issues involved.  We are all humans, and frustrations can be high on
 both sides of the process.  Try to keep in mind the immortal words of Bill and
 Ted, "Be excellent to each other."
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1 +0,0 @@
 GNU social's contributing resources and instructions are made available at [DOCUMENTATION/DEVELOPERS](https://notabug.org/diogo/gnu-social/src/nightly/DOCUMENTATION/DEVELOPERS).
--- a/+ 0
+++ b/+ 0
@@ -1,661 +0,0 @@
                    GNU AFFERO GENERAL PUBLIC LICENSE
                       Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
 software and other kinds of works, specifically designed to ensure
 cooperation with the community in the case of network server software.

  The licenses for most software and other practical works are designed
 to take away your freedom to share and change the works.  By contrast,
 our General Public Licenses are intended to guarantee your freedom to
 share and change all versions of a program--to make sure it remains free
 software for all its users.

  When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
 have the freedom to distribute copies of free software (and charge for
 them if you wish), that you receive source code or can get it if you
 want it, that you can change the software or use pieces of it in new
 free programs, and that you know you can do these things.

  Developers that use our General Public Licenses protect your rights
 with two steps: (1) assert copyright on the software, and (2) offer
 you this License which gives you legal permission to copy, distribute
 and/or modify the software.

  A secondary benefit of defending all users' freedom is that
 improvements made in alternate versions of the program, if they
 receive widespread use, become available for other developers to
 incorporate.  Many developers of free software are heartened and
 encouraged by the resulting cooperation.  However, in the case of
 software used on network servers, this result may fail to come about.
 The GNU General Public License permits making a modified version and
 letting the public access it on a server without ever releasing its
 source code to the public.

  The GNU Affero General Public License is designed specifically to
 ensure that, in such cases, the modified source code becomes available
 to the community.  It requires the operator of a network server to
 provide the source code of the modified version running there to the
 users of that server.  Therefore, public use of a modified version, on
 a publicly accessible server, gives the public access to the source
 code of the modified version.

  An older license, called the Affero General Public License and
 published by Affero, was designed to accomplish similar goals.  This is
 a different license, not a version of the Affero GPL, but Affero has
 released a new version of the Affero GPL which permits relicensing under
 this license.

  The precise terms and conditions for copying, distribution and
 modification follow.

                       TERMS AND CONDITIONS

  0. Definitions.

  "This License" refers to version 3 of the GNU Affero General Public License.

  "Copyright" also means copyright-like laws that apply to other kinds of
 works, such as semiconductor masks.

  "The Program" refers to any copyrightable work licensed under this
 License.  Each licensee is addressed as "you".  "Licensees" and
 "recipients" may be individuals or organizations.

  To "modify" a work means to copy from or adapt all or part of the work
 in a fashion requiring copyright permission, other than the making of an
 exact copy.  The resulting work is called a "modified version" of the
 earlier work or a work "based on" the earlier work.

  A "covered work" means either the unmodified Program or a work based
 on the Program.

  To "propagate" a work means to do anything with it that, without
 permission, would make you directly or secondarily liable for
 infringement under applicable copyright law, except executing it on a
 computer or modifying a private copy.  Propagation includes copying,
 distribution (with or without modification), making available to the
 public, and in some countries other activities as well.

  To "convey" a work means any kind of propagation that enables other
 parties to make or receive copies.  Mere interaction with a user through
 a computer network, with no transfer of a copy, is not conveying.

  An interactive user interface displays "Appropriate Legal Notices"
 to the extent that it includes a convenient and prominently visible
 feature that (1) displays an appropriate copyright notice, and (2)
 tells the user that there is no warranty for the work (except to the
 extent that warranties are provided), that licensees may convey the
 work under this License, and how to view a copy of this License.  If
 the interface presents a list of user commands or options, such as a
 menu, a prominent item in the list meets this criterion.

  1. Source Code.

  The "source code" for a work means the preferred form of the work
 for making modifications to it.  "Object code" means any non-source
 form of a work.

  A "Standard Interface" means an interface that either is an official
 standard defined by a recognized standards body, or, in the case of
 interfaces specified for a particular programming language, one that
 is widely used among developers working in that language.

  The "System Libraries" of an executable work include anything, other
 than the work as a whole, that (a) is included in the normal form of
 packaging a Major Component, but which is not part of that Major
 Component, and (b) serves only to enable use of the work with that
 Major Component, or to implement a Standard Interface for which an
 implementation is available to the public in source code form.  A
 "Major Component", in this context, means a major essential component
 (kernel, window system, and so on) of the specific operating system
 (if any) on which the executable work runs, or a compiler used to
 produce the work, or an object code interpreter used to run it.

  The "Corresponding Source" for a work in object code form means all
 the source code needed to generate, install, and (for an executable
 work) run the object code and to modify the work, including scripts to
 control those activities.  However, it does not include the work's
 System Libraries, or general-purpose tools or generally available free
 programs which are used unmodified in performing those activities but
 which are not part of the work.  For example, Corresponding Source
 includes interface definition files associated with source files for
 the work, and the source code for shared libraries and dynamically
 linked subprograms that the work is specifically designed to require,
 such as by intimate data communication or control flow between those
 subprograms and other parts of the work.

  The Corresponding Source need not include anything that users
 can regenerate automatically from other parts of the Corresponding
 Source.

  The Corresponding Source for a work in source code form is that
 same work.

  2. Basic Permissions.

  All rights granted under this License are granted for the term of
 copyright on the Program, and are irrevocable provided the stated
 conditions are met.  This License explicitly affirms your unlimited
 permission to run the unmodified Program.  The output from running a
 covered work is covered by this License only if the output, given its
 content, constitutes a covered work.  This License acknowledges your
 rights of fair use or other equivalent, as provided by copyright law.

  You may make, run and propagate covered works that you do not
 convey, without conditions so long as your license otherwise remains
 in force.  You may convey covered works to others for the sole purpose
 of having them make modifications exclusively for you, or provide you
 with facilities for running those works, provided that you comply with
 the terms of this License in conveying all material for which you do
 not control copyright.  Those thus making or running the covered works
 for you must do so exclusively on your behalf, under your direction
 and control, on terms that prohibit them from making any copies of
 your copyrighted material outside their relationship with you.

  Conveying under any other circumstances is permitted solely under
 the conditions stated below.  Sublicensing is not allowed; section 10
 makes it unnecessary.

  3. Protecting Users' Legal Rights From Anti-Circumvention Law.

  No covered work shall be deemed part of an effective technological
 measure under any applicable law fulfilling obligations under article
 11 of the WIPO copyright treaty adopted on 20 December 1996, or
 similar laws prohibiting or restricting circumvention of such
 measures.

  When you convey a covered work, you waive any legal power to forbid
 circumvention of technological measures to the extent such circumvention
 is effected by exercising rights under this License with respect to
 the covered work, and you disclaim any intention to limit operation or
 modification of the work as a means of enforcing, against the work's
 users, your or third parties' legal rights to forbid circumvention of
 technological measures.

  4. Conveying Verbatim Copies.

  You may convey verbatim copies of the Program's source code as you
 receive it, in any medium, provided that you conspicuously and
 appropriately publish on each copy an appropriate copyright notice;
 keep intact all notices stating that this License and any
 non-permissive terms added in accord with section 7 apply to the code;
 keep intact all notices of the absence of any warranty; and give all
 recipients a copy of this License along with the Program.

  You may charge any price or no price for each copy that you convey,
 and you may offer support or warranty protection for a fee.

  5. Conveying Modified Source Versions.

  You may convey a work based on the Program, or the modifications to
 produce it from the Program, in the form of source code under the
 terms of section 4, provided that you also meet all of these conditions:

    a) The work must carry prominent notices stating that you modified
    it, and giving a relevant date.

    b) The work must carry prominent notices stating that it is
    released under this License and any conditions added under section
    7.  This requirement modifies the requirement in section 4 to
    "keep intact all notices".

    c) You must license the entire work, as a whole, under this
    License to anyone who comes into possession of a copy.  This
    License will therefore apply, along with any applicable section 7
    additional terms, to the whole of the work, and all its parts,
    regardless of how they are packaged.  This License gives no
    permission to license the work in any other way, but it does not
    invalidate such permission if you have separately received it.

    d) If the work has interactive user interfaces, each must display
    Appropriate Legal Notices; however, if the Program has interactive
    interfaces that do not display Appropriate Legal Notices, your
    work need not make them do so.

  A compilation of a covered work with other separate and independent
 works, which are not by their nature extensions of the covered work,
 and which are not combined with it such as to form a larger program,
 in or on a volume of a storage or distribution medium, is called an
 "aggregate" if the compilation and its resulting copyright are not
 used to limit the access or legal rights of the compilation's users
 beyond what the individual works permit.  Inclusion of a covered work
 in an aggregate does not cause this License to apply to the other
 parts of the aggregate.

  6. Conveying Non-Source Forms.

  You may convey a covered work in object code form under the terms
 of sections 4 and 5, provided that you also convey the
 machine-readable Corresponding Source under the terms of this License,
 in one of these ways:

    a) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by the
    Corresponding Source fixed on a durable physical medium
    customarily used for software interchange.

    b) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by a
    written offer, valid for at least three years and valid for as
    long as you offer spare parts or customer support for that product
    model, to give anyone who possesses the object code either (1) a
    copy of the Corresponding Source for all the software in the
    product that is covered by this License, on a durable physical
    medium customarily used for software interchange, for a price no
    more than your reasonable cost of physically performing this
    conveying of source, or (2) access to copy the
    Corresponding Source from a network server at no charge.

    c) Convey individual copies of the object code with a copy of the
    written offer to provide the Corresponding Source.  This
    alternative is allowed only occasionally and noncommercially, and
    only if you received the object code with such an offer, in accord
    with subsection 6b.

    d) Convey the object code by offering access from a designated
    place (gratis or for a charge), and offer equivalent access to the
    Corresponding Source in the same way through the same place at no
    further charge.  You need not require recipients to copy the
    Corresponding Source along with the object code.  If the place to
    copy the object code is a network server, the Corresponding Source
    may be on a different server (operated by you or a third party)
    that supports equivalent copying facilities, provided you maintain
    clear directions next to the object code saying where to find the
    Corresponding Source.  Regardless of what server hosts the
    Corresponding Source, you remain obligated to ensure that it is
    available for as long as needed to satisfy these requirements.

    e) Convey the object code using peer-to-peer transmission, provided
    you inform other peers where the object code and Corresponding
    Source of the work are being offered to the general public at no
    charge under subsection 6d.

  A separable portion of the object code, whose source code is excluded
 from the Corresponding Source as a System Library, need not be
 included in conveying the object code work.

  A "User Product" is either (1) a "consumer product", which means any
 tangible personal property which is normally used for personal, family,
 or household purposes, or (2) anything designed or sold for incorporation
 into a dwelling.  In determining whether a product is a consumer product,
 doubtful cases shall be resolved in favor of coverage.  For a particular
 product received by a particular user, "normally used" refers to a
 typical or common use of that class of product, regardless of the status
 of the particular user or of the way in which the particular user
 actually uses, or expects or is expected to use, the product.  A product
 is a consumer product regardless of whether the product has substantial
 commercial, industrial or non-consumer uses, unless such uses represent
 the only significant mode of use of the product.

  "Installation Information" for a User Product means any methods,
 procedures, authorization keys, or other information required to install
 and execute modified versions of a covered work in that User Product from
 a modified version of its Corresponding Source.  The information must
 suffice to ensure that the continued functioning of the modified object
 code is in no case prevented or interfered with solely because
 modification has been made.

  If you convey an object code work under this section in, or with, or
 specifically for use in, a User Product, and the conveying occurs as
 part of a transaction in which the right of possession and use of the
 User Product is transferred to the recipient in perpetuity or for a
 fixed term (regardless of how the transaction is characterized), the
 Corresponding Source conveyed under this section must be accompanied
 by the Installation Information.  But this requirement does not apply
 if neither you nor any third party retains the ability to install
 modified object code on the User Product (for example, the work has
 been installed in ROM).

  The requirement to provide Installation Information does not include a
 requirement to continue to provide support service, warranty, or updates
 for a work that has been modified or installed by the recipient, or for
 the User Product in which it has been modified or installed.  Access to a
 network may be denied when the modification itself materially and
 adversely affects the operation of the network or violates the rules and
 protocols for communication across the network.

  Corresponding Source conveyed, and Installation Information provided,
 in accord with this section must be in a format that is publicly
 documented (and with an implementation available to the public in
 source code form), and must require no special password or key for
 unpacking, reading or copying.

  7. Additional Terms.

  "Additional permissions" are terms that supplement the terms of this
 License by making exceptions from one or more of its conditions.
 Additional permissions that are applicable to the entire Program shall
 be treated as though they were included in this License, to the extent
 that they are valid under applicable law.  If additional permissions
 apply only to part of the Program, that part may be used separately
 under those permissions, but the entire Program remains governed by
 this License without regard to the additional permissions.

  When you convey a copy of a covered work, you may at your option
 remove any additional permissions from that copy, or from any part of
 it.  (Additional permissions may be written to require their own
 removal in certain cases when you modify the work.)  You may place
 additional permissions on material, added by you to a covered work,
 for which you have or can give appropriate copyright permission.

  Notwithstanding any other provision of this License, for material you
 add to a covered work, you may (if authorized by the copyright holders of
 that material) supplement the terms of this License with terms:

    a) Disclaiming warranty or limiting liability differently from the
    terms of sections 15 and 16 of this License; or

    b) Requiring preservation of specified reasonable legal notices or
    author attributions in that material or in the Appropriate Legal
    Notices displayed by works containing it; or

    c) Prohibiting misrepresentation of the origin of that material, or
    requiring that modified versions of such material be marked in
    reasonable ways as different from the original version; or

    d) Limiting the use for publicity purposes of names of licensors or
    authors of the material; or

    e) Declining to grant rights under trademark law for use of some
    trade names, trademarks, or service marks; or

    f) Requiring indemnification of licensors and authors of that
    material by anyone who conveys the material (or modified versions of
    it) with contractual assumptions of liability to the recipient, for
    any liability that these contractual assumptions directly impose on
    those licensors and authors.

  All other non-permissive additional terms are considered "further
 restrictions" within the meaning of section 10.  If the Program as you
 received it, or any part of it, contains a notice stating that it is
 governed by this License along with a term that is a further
 restriction, you may remove that term.  If a license document contains
 a further restriction but permits relicensing or conveying under this
 License, you may add to a covered work material governed by the terms
 of that license document, provided that the further restriction does
 not survive such relicensing or conveying.

  If you add terms to a covered work in accord with this section, you
 must place, in the relevant source files, a statement of the
 additional terms that apply to those files, or a notice indicating
 where to find the applicable terms.

  Additional terms, permissive or non-permissive, may be stated in the
 form of a separately written license, or stated as exceptions;
 the above requirements apply either way.

  8. Termination.

  You may not propagate or modify a covered work except as expressly
 provided under this License.  Any attempt otherwise to propagate or
 modify it is void, and will automatically terminate your rights under
 this License (including any patent licenses granted under the third
 paragraph of section 11).

  However, if you cease all violation of this License, then your
 license from a particular copyright holder is reinstated (a)
 provisionally, unless and until the copyright holder explicitly and
 finally terminates your license, and (b) permanently, if the copyright
 holder fails to notify you of the violation by some reasonable means
 prior to 60 days after the cessation.

  Moreover, your license from a particular copyright holder is
 reinstated permanently if the copyright holder notifies you of the
 violation by some reasonable means, this is the first time you have
 received notice of violation of this License (for any work) from that
 copyright holder, and you cure the violation prior to 30 days after
 your receipt of the notice.

  Termination of your rights under this section does not terminate the
 licenses of parties who have received copies or rights from you under
 this License.  If your rights have been terminated and not permanently
 reinstated, you do not qualify to receive new licenses for the same
 material under section 10.

  9. Acceptance Not Required for Having Copies.

  You are not required to accept this License in order to receive or
 run a copy of the Program.  Ancillary propagation of a covered work
 occurring solely as a consequence of using peer-to-peer transmission
 to receive a copy likewise does not require acceptance.  However,
 nothing other than this License grants you permission to propagate or
 modify any covered work.  These actions infringe copyright if you do
 not accept this License.  Therefore, by modifying or propagating a
 covered work, you indicate your acceptance of this License to do so.

  10. Automatic Licensing of Downstream Recipients.

  Each time you convey a covered work, the recipient automatically
 receives a license from the original licensors, to run, modify and
 propagate that work, subject to this License.  You are not responsible
 for enforcing compliance by third parties with this License.

  An "entity transaction" is a transaction transferring control of an
 organization, or substantially all assets of one, or subdividing an
 organization, or merging organizations.  If propagation of a covered
 work results from an entity transaction, each party to that
 transaction who receives a copy of the work also receives whatever
 licenses to the work the party's predecessor in interest had or could
 give under the previous paragraph, plus a right to possession of the
 Corresponding Source of the work from the predecessor in interest, if
 the predecessor has it or can get it with reasonable efforts.

  You may not impose any further restrictions on the exercise of the
 rights granted or affirmed under this License.  For example, you may
 not impose a license fee, royalty, or other charge for exercise of
 rights granted under this License, and you may not initiate litigation
 (including a cross-claim or counterclaim in a lawsuit) alleging that
 any patent claim is infringed by making, using, selling, offering for
 sale, or importing the Program or any portion of it.

  11. Patents.

  A "contributor" is a copyright holder who authorizes use under this
 License of the Program or a work on which the Program is based.  The
 work thus licensed is called the contributor's "contributor version".

  A contributor's "essential patent claims" are all patent claims
 owned or controlled by the contributor, whether already acquired or
 hereafter acquired, that would be infringed by some manner, permitted
 by this License, of making, using, or selling its contributor version,
 but do not include claims that would be infringed only as a
 consequence of further modification of the contributor version.  For
 purposes of this definition, "control" includes the right to grant
 patent sublicenses in a manner consistent with the requirements of
 this License.

  Each contributor grants you a non-exclusive, worldwide, royalty-free
 patent license under the contributor's essential patent claims, to
 make, use, sell, offer for sale, import and otherwise run, modify and
 propagate the contents of its contributor version.

  In the following three paragraphs, a "patent license" is any express
 agreement or commitment, however denominated, not to enforce a patent
 (such as an express permission to practice a patent or covenant not to
 sue for patent infringement).  To "grant" such a patent license to a
 party means to make such an agreement or commitment not to enforce a
 patent against the party.

  If you convey a covered work, knowingly relying on a patent license,
 and the Corresponding Source of the work is not available for anyone
 to copy, free of charge and under the terms of this License, through a
 publicly available network server or other readily accessible means,
 then you must either (1) cause the Corresponding Source to be so
 available, or (2) arrange to deprive yourself of the benefit of the
 patent license for this particular work, or (3) arrange, in a manner
 consistent with the requirements of this License, to extend the patent
 license to downstream recipients.  "Knowingly relying" means you have
 actual knowledge that, but for the patent license, your conveying the
 covered work in a country, or your recipient's use of the covered work
 in a country, would infringe one or more identifiable patents in that
 country that you have reason to believe are valid.

  If, pursuant to or in connection with a single transaction or
 arrangement, you convey, or propagate by procuring conveyance of, a
 covered work, and grant a patent license to some of the parties
 receiving the covered work authorizing them to use, propagate, modify
 or convey a specific copy of the covered work, then the patent license
 you grant is automatically extended to all recipients of the covered
 work and works based on it.

  A patent license is "discriminatory" if it does not include within
 the scope of its coverage, prohibits the exercise of, or is
 conditioned on the non-exercise of one or more of the rights that are
 specifically granted under this License.  You may not convey a covered
 work if you are a party to an arrangement with a third party that is
 in the business of distributing software, under which you make payment
 to the third party based on the extent of your activity of conveying
 the work, and under which the third party grants, to any of the
 parties who would receive the covered work from you, a discriminatory
 patent license (a) in connection with copies of the covered work
 conveyed by you (or copies made from those copies), or (b) primarily
 for and in connection with specific products or compilations that
 contain the covered work, unless you entered into that arrangement,
 or that patent license was granted, prior to 28 March 2007.

  Nothing in this License shall be construed as excluding or limiting
 any implied license or other defenses to infringement that may
 otherwise be available to you under applicable patent law.

  12. No Surrender of Others' Freedom.

  If conditions are imposed on you (whether by court order, agreement or
 otherwise) that contradict the conditions of this License, they do not
 excuse you from the conditions of this License.  If you cannot convey a
 covered work so as to satisfy simultaneously your obligations under this
 License and any other pertinent obligations, then as a consequence you may
 not convey it at all.  For example, if you agree to terms that obligate you
 to collect a royalty for further conveying from those to whom you convey
 the Program, the only way you could satisfy both those terms and this
 License would be to refrain entirely from conveying the Program.

  13. Remote Network Interaction; Use with the GNU General Public License.

  Notwithstanding any other provision of this License, if you modify the
 Program, your modified version must prominently offer all users
 interacting with it remotely through a computer network (if your version
 supports such interaction) an opportunity to receive the Corresponding
 Source of your version by providing access to the Corresponding Source
 from a network server at no charge, through some standard or customary
 means of facilitating copying of software.  This Corresponding Source
 shall include the Corresponding Source for any work covered by version 3
 of the GNU General Public License that is incorporated pursuant to the
 following paragraph.

  Notwithstanding any other provision of this License, you have
 permission to link or combine any covered work with a work licensed
 under version 3 of the GNU General Public License into a single
 combined work, and to convey the resulting work.  The terms of this
 License will continue to apply to the part which is the covered work,
 but the work with which it is combined will remain governed by version
 3 of the GNU General Public License.

  14. Revised Versions of this License.

  The Free Software Foundation may publish revised and/or new versions of
 the GNU Affero General Public License from time to time.  Such new versions
 will be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.

  Each version is given a distinguishing version number.  If the
 Program specifies that a certain numbered version of the GNU Affero General
 Public License "or any later version" applies to it, you have the
 option of following the terms and conditions either of that numbered
 version or of any later version published by the Free Software
 Foundation.  If the Program does not specify a version number of the
 GNU Affero General Public License, you may choose any version ever published
 by the Free Software Foundation.

  If the Program specifies that a proxy can decide which future
 versions of the GNU Affero General Public License can be used, that proxy's
 public statement of acceptance of a version permanently authorizes you
 to choose that version for the Program.

  Later license versions may give you additional or different
 permissions.  However, no additional obligations are imposed on any
 author or copyright holder as a result of your choosing to follow a
 later version.

  15. Disclaimer of Warranty.

  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
 APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
 OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
 IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
 ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  16. Limitation of Liability.

  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
 THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
 GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
 USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
 DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
 PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
 EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGES.

  17. Interpretation of Sections 15 and 16.

  If the disclaimer of warranty and limitation of liability provided
 above cannot be given local legal effect according to their terms,
 reviewing courts shall apply local law that most closely approximates
 an absolute waiver of all civil liability in connection with the
 Program, unless a warranty or assumption of liability accompanies a
 copy of the Program in return for a fee.

                     END OF TERMS AND CONDITIONS

            How to Apply These Terms to Your New Programs

  If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it
 free software which everyone can redistribute and change under these terms.

  To do so, attach the following notices to the program.  It is safest
 to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.

    <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 Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

 Also add information on how to contact you by electronic and paper mail.

  If your software can interact with users remotely through a computer
 network, you should also make sure that it provides a way for users to
 get its source.  For example, if your program is a web application, its
 interface could display a "Source" link that leads users to an archive
 of the code.  There are many ways you could offer source, and different
 solutions will be better for different programs; see section 13 for the
 specific requirements.

  You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU AGPL, see
 <http://www.gnu.org/licenses/>.
--- a/DOCUMENTATION/DEVELOPERS/CONTRIBUTING/boilerplate.php
+++ b/DOCUMENTATION/DEVELOPERS/CONTRIBUTING/boilerplate.php
@@ -1,61 +0,0 @@
 <?php
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
 // GNU social is free software: you can redistribute it and/or modify
 // it under the terms of the GNU Affero General Public License as published by
 // the Free Software Foundation, either version 3 of the License, or
 // (at your option) any later version.
 //
 // GNU social is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 // GNU Affero General Public License for more details.
 //
 // You should have received a copy of the GNU Affero General Public License
 // along with GNU social.  If not, see <http://www.gnu.org/licenses/>.

 /**
 * Description of this file.
 *
 * @package   samples
 * @author    Diogo Cordeiro <diogo@fc.up.pt>
 * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */

 namespace samples;

 defined('GNUSOCIAL') || die();

 require_once __DIR__ . DIRECTORY_SEPARATOR . 'SampleHandler.php';

 /**
 * Description of this class.
 *
 * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */
 class MySampleClass
 {
    /**
     * Constructor for the sample class.
     *
     * @param string $dummy_word just because.
     * @param int $result another just because.
     */
    public function __construct(string $dummy_word = '', ?int $result = null)
    {
        global $demo;
        $this->niceWorld();
    }

    /**
     * How cool is this function.
     *
     * @return string
     */
    public function niceWorld(): string
    {
        return 'hello, world.';
    }
 }
--- a/DOCUMENTATION/DEVELOPERS/CONTRIBUTING/coding_standards.md
+++ b/DOCUMENTATION/DEVELOPERS/CONTRIBUTING/coding_standards.md
@@ -1,293 +0,0 @@
 GNU social Coding Style
 ===========================

 Please comply with [PSR-12](https://www.php-fig.org/psr/psr-12/) and the following standard when working on GNU social
 if you want your patches accepted and modules included in supported releases.

 If you see code which doesn't comply with the below, please fix it :)


 Strings
 -------------------------------------------------------------------------------
 Use `'` instead of `"` for strings, where substitutions aren't required.
 This is a performance issue, and prevents a lot of inconsistent coding styles.
 When using substitutions, use curly braces around your variables - like so:

    $var = "my_var: {$my_var}";


 Comments and Documentation
 -------------------------------------------------------------------------------
 Comments go on the line ABOVE the code, NOT to the right of the code, unless it is very short.
 All functions and methods are to be documented using PhpDocumentor - https://docs.phpdoc.org/guides/

 File Headers
 -------------------------------------------------------------------------------
 File headers follow a consistent format, as such:

    // This file is part of GNU social - https://www.gnu.org/software/social
    //
    // GNU social is free software: you can redistribute it and/or modify
    // it under the terms of the GNU Affero General Public License as published by
    // the Free Software Foundation, either version 3 of the License, or
    // (at your option) any later version.
    //
    // GNU social is distributed in the hope that it will be useful,
    // but WITHOUT ANY WARRANTY; without even the implied warranty of
    // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    // GNU Affero General Public License for more details.
    //
    // You should have received a copy of the GNU Affero General Public License
    // along with GNU social.  If not, see <http://www.gnu.org/licenses/>.

    /**
     * Description of this file.
     *
     * @package   samples
     * @author    Diogo Cordeiro <diogo@fc.up.pt>
     * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
     * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
     */

 Please use it.

 A few notes:

 *  The description of the file doesn't have to be exhaustive.  Rather it's
   meant to be a short summary of what's in this file and what it does.  Try
   to keep it to 1-5 lines.  You can get more in-depth when documenting
   individual functions!

 *  You'll probably see files with multiple authors, this is by
   design - many people contributed to GNU social or its forebears!  If you
   are modifying an existing file, APPEND your own author line, and update
   the copyright year if needed. Do not replace existing ones.

 You may find `boilerplate.php` useful when creating a new file from scratch.

 Paragraph spacing
 -------------------------------------------------------------------------------
 Where-ever possible, try to keep the lines to 80 characters.  Don't
 sacrifice readability for it though - if it makes more sense to have it in
 one longer line, and it's more easily read that way, that's fine.

 With assignments, avoid breaking them down into multiple lines unless
 neccesary, except for enumerations and arrays.


 'If' statements format
 -------------------------------------------------------------------------------
 Use switch statements where many else if's are going to be used. Switch/case is faster

    if ($var == 'example') {
        echo 'This is only an example';
    } else {
        echo 'This is not a test.  This is the real thing';
    }

 Do NOT make if statements like this:

    if ($var == 'example'){ echo 'An example'; }

    OR this

    if($var = 'example')
            echo "An {$var}";


 Associative arrays
 -------------------------------------------------------------------------------
 Always use `[]` instead of `array()`. Associative arrays must be written in the
 following manner:

    $array = [
        'var' => 'value',
        'var2' => 'value2'
    ];

 Note that spaces are preferred around the '=>'.


 A note about shorthands
 -------------------------------------------------------------------------------
 Some short hands are evil:

 - Use the long format for `<?php`.  Do NOT use `<?`.
 - Use the long format for `<?php` echo. Do NOT use `<?=`.


 Naming conventions
 -------------------------------------------------------------------------------
 Respect PSR-12 first.

 - Classes use PascalCase (e.g. MyClass).
 - Functions/Methods use camelCase (e.g. myFunction).
 - Variables use snake_case (e.g. my_variable).

 A note on variable names, etc. It must be possible to understand what is meant
 without neccesarialy seeing it in context, because the code that calls something
 might not always make it clear.

 So if you have something like:

    $notice->post($contents);

 Well I can easily tell what you're doing there because the names are straight-
 forward and clear.

 Something like this:

    foo->bar();

 Is much less clear.

 Also, whereever possible, avoid ambiguous terms.  For example, don't use text
 as a term for a variable.  Call back to "contents" above.


 Arrays
 -------------------------------------------------------------------------------
 Even though PSR-12 doesn't specifically specify rules for array formatting, it
 is in the spirit of it to have every array element on a new line like is done
 for function and class method arguments and condition expressions, if there is
 more than one element.
 In this case, even the last element should end on a comma, to ease later
 element addition.

    $foo = ['first' => 'unu'];
    $bar = [
        'first'  => 'once',
        'second' => 'twice',
        'third'  => 'thrice',
    ];


 Comparisons
 -------------------------------------------------------------------------------
 Always use symbol based comparison operators (&&, ||) instead of text based
 operators (and, or) in an "if" clause as they are evaluated in different order
 and at different speeds.
 This is will prevent any confusion or strange results.


 Use English
 -------------------------------------------------------------------------------
 All variables, classes, methods, functions and comments must be in English.
 Bad english is easier to work with than having to babelfish code to work out
 how it works.


 Encoding
 -------------------------------------------------------------------------------
 Files should be in UTF-8 encoding with UNIX line endings.


 No ending tag
 -------------------------------------------------------------------------------
 Files should not end with an ending php tag "?>".  Any whitespace after the
 closing tag is sent to the browser and cause errors, so don't include them.


 Nesting Functions
 -------------------------------------------------------------------------------
 Avoid, if at all possible.  When not possible, document the living daylights
 out of why you're nesting it.  It's not always avoidable, but PHP 5 has a lot
 of obscure problems that come up with using nested functions.

 If you must use a nested function, be sure to have robust error-handling.
 This is a must and submissions including nested functions that do not have
 robust error handling will be rejected and you'll be asked to add it.


 Scoping
 -------------------------------------------------------------------------------
 Properly enforcing scope of functions is something many PHP programmers don't
 do, but should.

 In general:
 *  Variables unique to a class should be protected and use interfacing to
   change them.  This allows for input validation and making sure we don't have
   injection, especially when something's exposed to the API, that any program
   can use, and not all of them are going to be be safe and trusted.

 *  Variables not unique to a class should be validated prior to every call,
   which is why it's generally not a good idea to re-use stuff across classes
   unless there's significant performance gains to doing so.

 *  Classes should protect functions that they do not want overriden, but they
   should avoid protecting the constructor and destructor and related helper
   functions as this prevents proper inheritance.


 Typecasting
 -------------------------------------------------------------------------------
 PHP is a soft-typed language and it falls to us developers to make sure that
 we are using the proper inputs.  Where ever possible use explicit type casting.
 Where it in't, you're going to have to make sure that you check all your
 inputs before you pass them.

 All outputs should be cast as an explicit PHP type.

 Not properly typecasting is a shooting offence.  Soft types let programmers
 get away with a lot of lazy code, but lazy code is buggy code, and frankly, I
 don't want it in GNU social if it's going to be buggy.


 Consistent exception handling
 -------------------------------------------------------------------------------
 Consistency is key to good code to begin with, but it is especially important
 to be consistent with how we handle errors.  GNU social has a variety of built-
 in exception classes.  Use them, wherever it's possible and appropriate, and
 they will do the heavy lifting for you.

 Additionally, ensure you clean up any and all records and variables that need
 cleanup in a function using try { } finally { } even if you do not plan on
 catching exceptions (why wouldn't you, though?  That's silly.)

 If you do not call an exception handler, you must, at a minimum, record errors
 to the log using common_log(level, message)

 Ensure all possible control flows of a function have exception handling and
 cleanup, where appropriate.  Don't leave endpoints with unhandled exceptions.
 Try not to leave something in an error state if it's avoidable.


 Return values
 -------------------------------------------------------------------------------
 All functions must return a value.  Every single one.  This is not optional.

 If you are simply making a procedure call, for example as part of a helper
 function, then return boolean TRUE on success, and the exception on failure.

 When returning the exception, return the whole nine yards, which is to say the
 actual PHP exception object, not just an error message.

 All return values not the above should be type cast, and you should sanitize
 anything returned to ensure it fits into the cast.  You might technically make
 an integer a string, for instance, but you should be making sure that integer
 SHOULD be a string, if you're returning it, and that it is a valid return
 value.

 A vast majority of programming errors come down to not checking your inputs
 and outputs properly, so please try to do so as best and thoroughly as you can.


 Layout and Location of files
 -------------------------------------------------------------------------------
 `/actions/` contains files that determine what happens when something "happens":
 for instance, when someone favourites or repeats a notice.  Code that is
 related to a "happening" should go here.

 `/classes/` contains abstract definitions of certain "things" in the codebase
 such as a user or notice.  If you're making a new "thing", it goes here.

 `/lib/` is basically the back-end.  Actions will call something in here to get
 stuff done usually, which in turn will probably manipulate information stored
 in one or more records represented by a class.

 `/extlib/` is where external libraries are located.  If you include a new
 external library, it goes here.

 `/plugins/` This is a great way to modularize your own new features.  If you want
 to create new core features for GNU social, it is probably best to create a
 module unless you absolutely must override or modify the core behaviours.
--- a/DOCUMENTATION/DEVELOPERS/CONTRIBUTING/merge_request_checklist.md
+++ b/DOCUMENTATION/DEVELOPERS/CONTRIBUTING/merge_request_checklist.md
@@ -1,32 +0,0 @@
 Submission Checklist
 ================================================================================
 This document serves as a handy checklist for submitted merges and patches to
 the GNU social project. Following it isn't a gaurantee a patch will be accepted,
 but it will help you avoid common problems.

 1. Ensure all code control paths in all functions return a value.

 2. Ensure all exceptions are trapped in an exception class, or minimally,
   written to the log with common_log

 3. Ensure the coding format standards are adhered to (see coding_standards.md)

 4. Ensure that any new class that deals in public data has a corresponding new
   API endpoint.

 5. Ensure that all new API endpoints sanitize inputs and outputs properly.

 6. Ensure that your version of the code works with PHP 7 on a standard
   LAMP and LEMP stack (Linux+Apache+MariaDB+PHP and Linux+nginx+MariaDB+PHP)

 7. If implementing new database functions, ensure they work with MariaDB
   and postgreSQL.

 8. Ensure all data that federates does so properly and has mechanisms to
   catch and accomodate for federation transmission failure.

 9. Ensure that nothing is left in an error state when it is avoidable.

 10. Ensure that all code submitted is properly documented.

 11. Ensure that there are no PHP Strict Standards or Parse errors in the code.
--- a/DOCUMENTATION/DEVELOPERS/EVENTS.txt
+++ b/DOCUMENTATION/DEVELOPERS/EVENTS.txt
--- a/DOCUMENTATION/DEVELOPERS/Plugins/README.md
+++ b/DOCUMENTATION/DEVELOPERS/Plugins/README.md
@@ -1,350 +0,0 @@
 Plugin Development
 ==================

 SamplePlugin.php
 ----------------

 Each plugin requires a main class to interact with the GNU social system.

 The main class usually extends the Plugin class that comes with GNU social.

 The class has standard-named methods that will be called when certain events
 happen in the code base. These methods have names like 'onX' where X is an
 event name (see EVENTS.txt for the list of available events). Event handlers
 have pre-defined arguments, based on which event they're handling. A typical
 event handler:

 ```php
 public function onSomeEvent($paramA, &$paramB): bool
 {
    if ($paramA == 'jed') {
        throw new Exception(sprintf(_m("Invalid parameter %s"), $paramA));
    }
    $paramB = 'spock';
    return true;
 }
 ```

 Event Handlers
 --------------

 Event handlers must return a Boolean value.

 If they return false, all other event handlers for this event (in other plug-in)
 will be skipped, and in some cases the default processing for that event would
 be skipped. This is great for replacing the default action of an event.

 If the handler returns true, processing of other event handlers and the default
 processing will continue. This is great for extending existing functionality.

 If the handler throws an exception, processing will stop, and the exception's
 error will be shown to the user.

 Installation
 ------------

 To enable a plugin (like the SamplePlugin), site admins add the following code to their
 config.php file:

 ```php
 addPlugin('Sample');
 ```

 Third Party Plugins must be installed in `local/plugins/{$name}/{$pluginclass}.php`

 Here, `{$name}` is the name of the plugin, like 'Sample', and `{$pluginclass}`
 is the name of the main class, like 'SamplePlugin'. Plugins that are part of
 the main GNU social distribution go in 'plugins' and third-party or local ones
 go in 'local'.

 Simple plugins can be implemented as a single plugin. Others are more complex
 and require additional plugins; these should use their own directory, like
 'local/plugins/{$name}/'. All files related to the plugin, including images,
 JavaScript, CSS, external libraries or PHP plugins should go in the plugin
 directory.

 Plugin Configuration
 --------------------

 Plugins are configured using public instance attributes. To set their values,
 site administrators use this syntax:

 ```php
 addPlugin('Sample', ['attr1' => 'foo', 'attr2' => 'bar']);
 ```

 The same plugin class can be initialized multiple times with different arguments:

 ```php
 addPlugin('EmailNotify', ['sendTo' => 'evan@status.net']);
 addPlugin('EmailNotify', ['sendTo' => 'brionv@status.net']);
 ```

 ```php
 class SamplePlugin extends Plugin
 {
    public $attr1 = null;
    public $attr2 = null;
 }
 ```

 Initialization
 --------------

 Plugins overload this method to do any initialization they need, like connecting
 to remote servers or creating paths or so on. @return bool hook value; true
 means continue processing, false means stop.

 ```php
 public function initialize(): bool
 {
    return true;
 }
 ```

 Clean Up
 --------

 Plugins overload this method to do any cleanup they need, like disconnecting from
 remote servers or deleting temp files or so on.

 ```php
 public function cleanup(): bool
 {
    return true;
 }
 ```

 Database schema setup
 ---------------------

 Plugins can add their own tables to the GNU social database. Plugins should use
 GNU social's schema interface to add or delete tables. The ensureTable() method
 provides an easy way to ensure a table's structure and availability.

 By default, the schema is checked every time GNU social is run (say, when a Web
 page is hit). Admins can configure their systems to only check the schema when
 the checkschema.php script is run, greatly improving performance. However, they
 need to remember to run that script after installing or upgrading a plugin!

 ```php
 public function onCheckSchema(): bool
 {
    $schema = Schema::get();

    // '''For storing user-submitted flags on profiles'''

    $schema->ensureTable('user_greeting_count',[
            new ColumnDef('user_id', 'integer', null, true, 'PRI'),
            new ColumnDef('greeting_count', 'integer')
        ]
    );

    return true;
 }
 ```

 Load related plugins when needed
 --------------------------------

 Most non-trivial plugins will require extra plugins to do their work. Typically
 these include data classes, action classes, widget classes, or external libraries.

 This method receives a class name and loads the PHP file related to that class.
 By tradition, action classes typically have files named for the action, all
 lower-case. Data classes are in files with the data class name, initial letter
 capitalized.

 Note that this method will be called for *all* overloaded classes, not just ones
 in this plugin! So, make sure to return true by default to let other plugins,
 and the core code, get a chance.

 ```php
 public function onAutoload($cls): bool
 {
    $dir = __DIR__;

    switch ($cls)
    {
        case 'HelloAction':
            include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
            return false;
        case 'User_greeting_count':
            include_once $dir . '/'.$cls.'.php';
            return false;
        default:
            return true;
    }
 }
 ```

 Map URLs to actions
 -------------------

 This event handler lets the plugin map URLs on the site to actions (and thus an
 action handler class). Note that the action handler class for an action will be
 named 'FoobarAction', where action = 'foobar'. The class must be loaded in the
 onAutoload() method.

 ```php
 public function onRouterInitialized($m): bool
 {
    $m->connect('main/hello',
                ['action' => 'hello']);
    return true;
 }
 ```

 Modify the default menu to link to our custom action
 -----------------------------------------------------

 Using event handlers, it's possible to modify the default UI for pages almost
 without limit. In this method, we add a menu item to the default primary menu
 for the interface to link to our action.

 Action Class
 ------------

 The Action class provides a rich set of events to hook, as well as output methods.

 ```php
 public function onEndPrimaryNav($action): bool
 {
    // '''common_local_url()''' gets the correct URL for the action name we provide

    $action->menuItem(common_local_url('hello'),
                      _m('Hello'), _m('A warm greeting'), false, 'nav_hello');
    return true;
 }

 public function onPluginVersion(&$versions): bool
 {
    $versions[] = [
        'name' => 'Sample',
        'version' => GNUSOCIAL_VERSION,
        'author' => 'Brion Vibber, Evan Prodromou',
        'homepage' => 'http://example.org/plugin',
        'rawdescription' =>
        _m('A sample plugin to show basics of development for new hackers.')
    ];
    return true;
 }
 ```

 hello.php
 ---------

 This section is taken directly from the 'hello.php'. ( plugins/Sample/hello.php )

 Give a warm greeting to our friendly user.

 This sample action shows some basic ways of doing output in an action class.

 Action classes have several output methods that they override from the parent class.

 ```php
 class HelloAction extends Action
 {
    var $user = null;
    var $gc   = null;
 }
 ```

 Take arguments for running
 --------------------------

 This method is called first, and it lets the action class get all its arguments
 and validate them. It's also the time to fetch any relevant data from the database.

 Action classes should run parent::prepare(array $args = []) as the first line
 of this method to make sure the default argument-processing happens.

 ```php
 public function prepare(array $args = []): bool
 {
    parent::prepare($args);

    $this->user = common_current_user();

    if (!empty($this->user)) {
        $this->gc = User_greeting_count::inc($this->user->id);
    }

    return true;
 }
 ```

 Handle request
 --------------

 This is the main method for handling a request. Note that most preparation
 should be done in the prepare() method; by the time handle() is called the
 action should be more or less ready to go.

 ```php
 public function handle(): void
 {
    parent::handle();

    $this->showPage();
 }
 ```

 Title of this page
 ------------------

 Override this method to show a custom title.

 ```php
 public function title(): string
 {
    if (empty($this->user)) {
        return _m('Hello');
    } else {
        return sprintf(_m('Hello, %s'), $this->user->nickname);
    }
 }
 ```

 Show content in the content area
 --------------------------------

 The default GNU social page has a lot of decorations: menus, logos, tabs, all
 that jazz. This method is used to show content in the content area of the
 page; it's the main thing you want to overload. This method also demonstrates
 use of a plural localized string.

 ```php
 public function showContent(): void
 {
    if (empty($this->user)) {
        $this->element('p', ['class' => 'greeting'],
                       _m('Hello, stranger!'));
    } else {
        $this->element('p', ['class' => 'greeting'],
                       sprintf(_m('Hello, %s'), $this->user->nickname));
        $this->element('p', ['class' => 'greeting_count'],
                       sprintf(_m('I have greeted you %d time.',
                                  'I have greeted you %d times.',
                                  $this->gc->greeting_count),
                                  $this->gc->greeting_count));
    }
 }
 ```

 Return true if read only.
 -------------------------

 Some actions only read from the database; others read and write. The simple
 database load-balancer built into GNU social will direct read-only actions to
 database mirrors (if they are configured) and read-write actions to the master database.

 This defaults to false to avoid data integrity issues, but you should make sure
 to overload it for performance gains.

 ```php
 public function isReadOnly($args): bool
 {
    return false;
 }
 ```
--- a/Plugins/Awesomeness/includes/AwesomenessPlugin.php
+++ b/Plugins/Awesomeness/includes/AwesomenessPlugin.php
@@ -1,90 +0,0 @@
 <?php
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
 // GNU social is free software: you can redistribute it and/or modify
 // it under the terms of the GNU Affero General Public License as published by
 // the Free Software Foundation, either version 3 of the License, or
 // (at your option) any later version.
 //
 // GNU social is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 // GNU Affero General Public License for more details.
 //
 // You should have received a copy of the GNU Affero General Public License
 // along with GNU social.  If not, see <http://www.gnu.org/licenses/>.

 defined('GNUSOCIAL') || die();

 /**
 * Fun sample plugin: tweaks input data and adds a 'Cornify' widget to sidebar.
 *
 * @category Plugin
 * @package  GNUsocial
 * @author   Jeroen De Dauw <jeroendedauw@gmail.com>
 * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */

 class AwesomenessPlugin extends Plugin
 {
    const PLUGIN_VERSION = '13.37.42';

    public function onPluginVersion(array &$versions): bool
    {
        $versions[] = [
            'name' => 'Awesomeness',
            'version' => self::PLUGIN_VERSION,
            'author' => 'Jeroen De Dauw',
            'homepage' => GNUSOCIAL_ENGINE_REPO_URL . 'tree/master/plugins/Awesomeness',
            // TRANS: Plugin description for a sample plugin.
            'rawdescription' => _m('The Awesomeness plugin adds additional awesomeness ' .
                'to a GNU social installation.')
        ];
        return true;
    }

    /**
     * Add the conrnify button
     *
     * @param Action $action the current action
     *
     * @return void
     */
    public function onEndShowSections(Action $action)
    {
        $action->elementStart('div', ['id'    => 'cornify_section',
                                      'class' => 'section']);

        $action->raw(
            <<<EOT
                <a href="https://www.cornify.com" onclick="cornify_add();return false;">
                <img src="https://www.cornify.com/assets/cornify.gif" width="61" height="16" border="0" alt="Cornify" />
                </a>
 EOT
        );

        $action->elementEnd('div');
    }

    public function onEndShowScripts(Action $action)
    {
        $action->script($this->path('js/cornify.js'));
    }

    /**
     * Hook for new-notice form processing to take our HTML goodies;
     * won't affect API posting etc.
     *
     * @param NewNoticeAction $action
     * @param User $user
     * @param string $content
     * @param array $options
     * @return bool hook return
     */
    public function onStartSaveNewNoticeWeb($action, $user, &$content, &$options)
    {
        $content = htmlspecialchars($content);
        $options['rendered'] = preg_replace("/(^|\s|-)((?:awesome|awesomeness)[\?!\.\,]?)(\s|$)/i", " <b>$2</b> ", $content);
    }
 }
--- a/DOCUMENTATION/DEVELOPERS/Plugins/Sample
+++ b/DOCUMENTATION/DEVELOPERS/Plugins/Sample
@@ -1,14 +0,0 @@
 Fun sample plugin: tweaks input data and adds a 'Cornify' ( http://www.cornify.com ) widget to sidebar.

 Installation
 ============
 add "addPlugin('Awesomeness');"
 to the bottom of your config.php

 Settings
 ========
 none

 Example
 =======
 addPlugin('Awesomeness');
--- a/Plugins/Awesomeness/includes/locale/Awesomeness.pot
+++ b/Plugins/Awesomeness/includes/locale/Awesomeness.pot
@@ -1,25 +0,0 @@
 # SOME DESCRIPTIVE TITLE.
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
 #
 #, fuzzy
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2019-08-14 14:51+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "Language: \n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=CHARSET\n"
 "Content-Transfer-Encoding: 8bit\n"

 #. TRANS: Module description for a sample plugin.
 #: AwesomenessModule.php:67
 msgid ""
 "The Awesomeness plugin adds additional awesomeness to a GNU social "
 "installation."
 msgstr ""
--- a/Plugins/Awesomeness/includes/locale/af/LC_MESSAGES/Awesomeness.po
+++ b/Plugins/Awesomeness/includes/locale/af/LC_MESSAGES/Awesomeness.po
@@ -1,25 +0,0 @@
 # Translation file for GNU social - the free software social networking platform
 # Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
 # This file is under https://www.gnu.org/licenses/agpl v3 or later
 # 
 # Translators:
 msgid ""
 msgstr ""
 "Project-Id-Version: GNU social\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2015-02-02 17:47+0100\n"
 "PO-Revision-Date: 2015-02-06 14:56+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: Afrikaans (http://www.transifex.com/gnu-social/gnu-social/language/af/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Language: af\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"

 #. TRANS: Plugin description for a sample plugin.
 #: AwesomenessPlugin.php:55
 msgid ""
 "The Awesomeness plugin adds additional awesomeness to a GNU social "
 "installation."
 msgstr ""
--- a/Plugins/Awesomeness/includes/locale/ar/LC_MESSAGES/Awesomeness.po
+++ b/Plugins/Awesomeness/includes/locale/ar/LC_MESSAGES/Awesomeness.po
@@ -1,25 +0,0 @@
 # Translation file for GNU social - the free software social networking platform
 # Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
 # This file is under https://www.gnu.org/licenses/agpl v3 or later
 # 
 # Translators:
 msgid ""
 msgstr ""
 "Project-Id-Version: GNU social\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2015-02-02 17:47+0100\n"
 "PO-Revision-Date: 2015-02-06 14:56+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: Arabic (http://www.transifex.com/gnu-social/gnu-social/language/ar/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Language: ar\n"
 "Plural-Forms: nplurals=6; plural=n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 && n%100<=10 ? 3 : n%100>=11 && n%100<=99 ? 4 : 5;\n"

 #. TRANS: Plugin description for a sample plugin.
 #: AwesomenessPlugin.php:55
 msgid ""
 "The Awesomeness plugin adds additional awesomeness to a GNU social "
 "installation."
 msgstr ""
--- a/Plugins/Awesomeness/includes/locale/arz/LC_MESSAGES/Awesomeness.po
+++ b/Plugins/Awesomeness/includes/locale/arz/LC_MESSAGES/Awesomeness.po
@@ -1,25 +0,0 @@
 # Translation file for GNU social - the free software social networking platform
 # Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
 # This file is under https://www.gnu.org/licenses/agpl v3 or later
 # 
 # Translators:
 msgid ""
 msgstr ""
 "Project-Id-Version: GNU social\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2015-02-02 17:47+0100\n"
 "PO-Revision-Date: 2015-02-06 14:56+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: Arabic (Egypt) (http://www.transifex.com/gnu-social/gnu-social/language/ar_EG/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Language: ar_EG\n"
 "Plural-Forms: nplurals=6; plural=n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 && n%100<=10 ? 3 : n%100>=11 && n%100<=99 ? 4 : 5;\n"

 #. TRANS: Plugin description for a sample plugin.
 #: AwesomenessPlugin.php:55
 msgid ""
 "The Awesomeness plugin adds additional awesomeness to a GNU social "
 "installation."
 msgstr ""
--- a/Plugins/Awesomeness/includes/locale/ast/LC_MESSAGES/Awesomeness.po
+++ b/Plugins/Awesomeness/includes/locale/ast/LC_MESSAGES/Awesomeness.po
@@ -1,25 +0,0 @@
 # Translation file for GNU social - the free software social networking platform
 # Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
 # This file is under https://www.gnu.org/licenses/agpl v3 or later
 # 
 # Translators:
 msgid ""
 msgstr ""
 "Project-Id-Version: GNU social\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2015-02-02 17:47+0100\n"
 "PO-Revision-Date: 2015-02-06 14:56+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: Asturian (http://www.transifex.com/gnu-social/gnu-social/language/ast/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Language: ast\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"

 #. TRANS: Plugin description for a sample plugin.
 #: AwesomenessPlugin.php:55
 msgid ""
 "The Awesomeness plugin adds additional awesomeness to a GNU social "
 "installation."
 msgstr ""
--- a/Plugins/Awesomeness/includes/locale/be-tarask/LC_MESSAGES/Awesomeness.po
+++ b/Plugins/Awesomeness/includes/locale/be-tarask/LC_MESSAGES/Awesomeness.po
@@ -1,25 +0,0 @@
 # Translation file for GNU social - the free software social networking platform
 # Copyright (C) 2011 - 2019 Free Software Foundation, Inc http://www.fsf.org
 # This file is under https://www.gnu.org/licenses/agpl v3 or later
 # 
 # Translators:
 msgid ""
 msgstr ""
 "Project-Id-Version: GNU social\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2015-02-02 17:47+0100\n"
 "PO-Revision-Date: 2015-02-06 15:02+0000\n"
 "Last-Translator: digitaldreamer <digitaldreamer@email.cz>\n"
 "Language-Team: Belarusian (Tarask) (http://www.transifex.com/gnu-social/gnu-social/language/be@tarask/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Language: be@tarask\n"
 "Plural-Forms: nplurals=4; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<12 || n%100>14) ? 1 : n%10==0 || (n%10>=5 && n%10<=9) || (n%100>=11 && n%100<=14)? 2 : 3);\n"

 #. TRANS: Plugin description for a sample plugin.
 #: AwesomenessPlugin.php:55
 msgid ""
 "The Awesomeness plugin adds additional awesomeness to a GNU social "
 "installation."
 msgstr "Дапаўненьне Awesomeness дадае незвычайныя магчымасьці ў усталяваньне GNU social."
--- a/Plugins/Awesomeness/includes/locale/bg/LC_MESSAGES/Awesomeness.po
+++ b/Plugins/Awesomeness/includes/locale/bg/LC_MESSAGES/Awesomeness.po
@@ -1,25 +0,0 @@
 # Translation file for GNU social - the free software social networking platform
 # Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
 # This file is under https://www.gnu.org/licenses/agpl v3 or later
 # 
 # Translators:
 msgid ""
 msgstr ""
 "Project-Id-Version: GNU social\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2015-02-02 17:47+0100\n"
 "PO-Revision-Date: 2015-02-06 14:56+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: Bulgarian (http://www.transifex.com/gnu-social/gnu-social/language/bg/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Language: bg\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"

 #. TRANS: Plugin description for a sample plugin.
 #: AwesomenessPlugin.php:55
 msgid ""
 "The Awesomeness plugin adds additional awesomeness to a GNU social "
 "installation."
 msgstr ""
--- a/Plugins/Awesomeness/includes/locale/bn_IN/LC_MESSAGES/Awesomeness.po
+++ b/Plugins/Awesomeness/includes/locale/bn_IN/LC_MESSAGES/Awesomeness.po
@@ -1,25 +0,0 @@
 # Translation file for GNU social - the free software social networking platform
 # Copyright (C) 2015 - 2019 Free Software Foundation