Merge pull request 'Updated to v0.3' (#12) from dev into master

Reviewed-on: #12

.gitignore

@@ -0,0 +1,157 @@
+# ---> Python
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Custom
+.vscode
+config.json

.renovaterc

@@ -0,0 +1,20 @@
+{
+    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+    "extends": [
+        "config:base"
+    ],
+    "baseBranches": [
+        "dev"
+    ],
+    "packageRules": [
+        {
+            "matchUpdateTypes": [
+                "minor",
+                "patch",
+                "pin",
+                "digest"
+            ],
+            "automerge": true
+        }
+    ]
+}

LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://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 <https://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:
+
+    <program>  Copyright (C) <year>  <name of author>
+    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
+<https://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
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -0,0 +1,99 @@
+<h1 align="center">Photos API</h1>
+
+<p align="center">
+<a href="https://git.end-play.xyz/profitroll/PhotosAPILICENSE"><img alt="License: GPL" src="https://img.shields.io/badge/License-GPL-blue"></a>
+<a href="https://git.end-play.xyz/profitroll/PhotosAPI"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+</p>  
+
+Small and simple API server for saving photos and videos.
+
+## Dependencies
+
+* [Python 3.8+](https://www.python.org) (3.9+ recommended)
+* [MongoDB](https://www.mongodb.com)
+* [exiftool](https://exiftool.org)
+* [jpegoptim](https://github.com/tjko/jpegoptim)
+* [optipng](https://optipng.sourceforge.net)
+
+## Installation
+
+First you need to have a Python interpreter, MongoDB and optionally git. You can also ignore git and simply download source code, should also work fine. After that you're ready to go.  
+
+> In this README I assume that you're using default python in your
+> system and your system's PATH contains it. If your default python
+> is `python3` or for example `/home/user/.local/bin/python3.9` - use it instead.
+
+1. Install Mongo:
+
+    Please follow [official installation manual](https://www.mongodb.com/docs/manual/installation) for that.
+
+2. Download Photos API:
+
+    1. `git clone https://git.end-play.xyz/profitroll/PhotosAPI.git` (if you're using git)
+    2. `cd PhotosAPI`
+
+3. Create virtual environment [Optional yet recommended]:
+
+    1. Install virtualenv module: `pip install virtualenv`
+    2. Create venv: `python -m venv env`
+    3. Activate it using `source venv/bin/activate` on Linux, `venv\Scripts\activate.bat` in CMD or `venv\Scripts\Activate.ps1` in PowerShell.
+
+4. Install project's dependencies:  
+
+    `python -m pip install -r requirements.txt`
+
+5. Configure your API:
+
+    1. Copy file `config_example.json` to `config.json`
+    2. Open `config.json` using your favorite text editor. For example `nano config.json`
+    3. Change `"database"` keys to match your MongoDB setup
+    4. Change `"external_address"` to the ip/http address you may get in responses. By default it's `"localhost"`. This is extremely useful when running behind reverse-proxy.  
+
+    After configuring everything listed above your API will be able to boot, however further configuration can be done. You can read about it in [repository's wiki](https://git.end-play.xyz/profitroll/PhotosAPI/wiki/Configuration). There's no need to focus on that now, it makes more sense to configure it afterwards.
+
+6. Start your API:
+
+    You can run your API by the following command:  
+    `uvicorn photos_api:app --host 127.0.0.1 --port 8054`  
+
+    Learn more about available uvicorn arguments using `uvicorn --help`
+
+## Using as a service
+
+It's a good practice to use your API as a systemd service on Linux. Here's a quick overview how that can be done.  
+
+1. Create user and move your API
+
+    You don't always need to do so, but that's a cleaner way to deploy a service.  
+
+    1. Create service user `photosapi` using `sudo useradd -r -U photosapi`
+    2. Assuming you are still in directory `PhotosAPI`, use `cd ..` to go up a level and then move your API to the distinguished folder. For example, `/opt/`: `sudo mv ./PhotosAPI /opt/`
+    3. Make your user and its group own their directory using `sudo chown -R photosapi:photosapi /opt/PhotosAPI`
+
+2. Configure service
+
+    Here's an example service file for PhotosAPI that is using virtual environment:
+
+    ```systemd
+    [Unit]
+    Description=Photos API
+    After=network.target mongod.service
+    Wants=network-online.target mongod.service
+
+    [Service]
+    Restart=always
+    Type=simple
+    ExecStart=/bin/bash -c 'source venv/bin/activate && venv/bin/uvicorn photos_api:app --port 8054'
+    WorkingDirectory=/opt/PhotosAPI
+    User=photosapi
+    Group=photosapi
+
+    [Install]
+    WantedBy=multi-user.target
+    ```  
+
+    1. Create a service by pasting code above into `/etc/systemd/system/photos-api.service`
+    2. Enable your service to start on system boot using `sudo systemctl enable photos-api.service`
+    3. Start your service now using `sudo systemctl start photos-api.service`
+    4. Check if it's running using `sudo systemctl status photos-api.service`
+    5. If something goes wrong - check API's logs using `sudo journalctl -u photos-api.service`

classes/exceptions.py

@@ -0,0 +1,268 @@
+from typing import Literal
+
+from fastapi import HTTPException
+
+
+class AlbumNotFoundError(HTTPException):
+    """Raises HTTP 404 if no album with this ID found."""
+
+    def __init__(self, id: str):
+        self.id = id
+        self.openapi = {
+            "description": "Album Does Not Exist",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Could not find album with id '{id}'."}
+                }
+            },
+        }
+
+
+class AlbumNameNotFoundError(HTTPException):
+    """Raises HTTP 404 if no album with this name found."""
+
+    def __init__(self, name: str):
+        self.name = name
+        self.openapi = {
+            "description": "Album Does Not Exist",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Could not find album with name '{name}'."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=404,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(name=self.name),
+        )
+
+
+class AlbumAlreadyExistsError(HTTPException):
+    """Raises HTTP 409 if album with this name already exists."""
+
+    def __init__(self, name: str):
+        self.name = name
+        self.openapi = {
+            "description": "Album Already Exists",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Album with name '{name}' already exists."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=409,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(name=self.name),
+        )
+
+
+class AlbumIncorrectError(HTTPException):
+    """Raises HTTP 406 if album's title or name is invalid."""
+
+    def __init__(self, place: Literal["name", "title"], error: str) -> None:
+        self.place = place
+        self.error = error
+        self.openapi = {
+            "description": "Album Name/Title Invalid",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Album {place} invalid: {error}"}
+                }
+            },
+        }
+        super().__init__(
+            status_code=406,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(place=self.place, error=self.error),
+        )
+
+
+class PhotoNotFoundError(HTTPException):
+    """Raises HTTP 404 if no photo with this ID found."""
+
+    def __init__(self, id: str):
+        self.id = id
+        self.openapi = {
+            "description": "Photo Does Not Exist",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Could not find photo with id '{id}'."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=404,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(id=self.id),
+        )
+
+
+class PhotoSearchQueryEmptyError(HTTPException):
+    """Raises HTTP 422 if no photo search query provided."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Query",
+            "content": {
+                "application/json": {
+                    "example": {
+                        "detail": "You must provide query, caption or coordinates to look for photos."
+                    }
+                }
+            },
+        }
+        super().__init__(
+            status_code=422,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class VideoNotFoundError(HTTPException):
+    """Raises HTTP 404 if no video with this ID found."""
+
+    def __init__(self, id: str):
+        self.id = id
+        self.openapi = {
+            "description": "Video Does Not Exist",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Could not find video with id '{id}'."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=404,
+            detail=self.openapi["content"]["application/json"]["example"][
+                "detail"
+            ].format(id=self.id),
+        )
+
+
+class VideoSearchQueryEmptyError(HTTPException):
+    """Raises HTTP 422 if no video search query provided."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Query",
+            "content": {
+                "application/json": {
+                    "example": {
+                        "detail": "You must provide query or caption to look for videos."
+                    }
+                }
+            },
+        }
+        super().__init__(
+            status_code=422,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class SearchPageInvalidError(HTTPException):
+    """Raises HTTP 400 if page or page size are not in valid range."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Page",
+            "content": {
+                "application/json": {
+                    "example": {
+                        "detail": "Parameters 'page' and 'page_size' must be greater or equal to 1."
+                    }
+                }
+            },
+        }
+        super().__init__(
+            status_code=400,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class SearchTokenInvalidError(HTTPException):
+    """Raises HTTP 401 if search token is not valid."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Token",
+            "content": {
+                "application/json": {"example": {"detail": "Invalid search token."}}
+            },
+        }
+        super().__init__(
+            status_code=401,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class UserEmailCodeInvalid(HTTPException):
+    """Raises HTTP 400 if email confirmation code is not valid."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Email Code",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "Confirmation code is invalid."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=400,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class UserAlreadyExists(HTTPException):
+    """Raises HTTP 409 if user with this name already exists."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "User Already Exists",
+            "content": {
+                "application/json": {
+                    "example": {"detail": "User with this username already exists."}
+                }
+            },
+        }
+        super().__init__(
+            status_code=409,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class AccessTokenInvalidError(HTTPException):
+    """Raises HTTP 401 if access token is not valid."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Access Token",
+            "content": {
+                "application/json": {"example": {"detail": "Invalid access token."}}
+            },
+        }
+        super().__init__(
+            status_code=401,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )
+
+
+class UserCredentialsInvalid(HTTPException):
+    """Raises HTTP 401 if user credentials are not valid."""
+
+    def __init__(self):
+        self.openapi = {
+            "description": "Invalid Credentials",
+            "content": {
+                "application/json": {"example": {"detail": "Invalid credentials."}}
+            },
+        }
+        super().__init__(
+            status_code=401,
+            detail=self.openapi["content"]["application/json"]["example"]["detail"],
+        )

classes/models.py

@@ -0,0 +1,74 @@
+from typing import List, Union
+
+from pydantic import BaseModel
+
+
+class Photo(BaseModel):
+    id: str
+    album: str
+    hash: str
+    filename: str
+
+
+class PhotoPublic(BaseModel):
+    id: str
+    caption: str
+    filename: str
+
+
+class PhotoSearch(BaseModel):
+    id: str
+    filename: str
+    caption: Union[str, None]
+
+
+class Video(BaseModel):
+    id: str
+    album: str
+    hash: str
+    filename: str
+
+
+class VideoPublic(BaseModel):
+    id: str
+    caption: str
+    filename: str
+
+
+class VideoSearch(BaseModel):
+    id: str
+    filename: str
+    caption: Union[str, None]
+
+
+class Album(BaseModel):
+    id: str
+    name: str
+    title: str
+
+
+class AlbumSearch(BaseModel):
+    id: str
+    name: str
+    title: str
+
+
+class AlbumModified(BaseModel):
+    name: str
+    title: str
+    cover: Union[str, None]
+
+
+class SearchResultsAlbum(BaseModel):
+    results: List[Album]
+    next_page: Union[str, None]
+
+
+class SearchResultsPhoto(BaseModel):
+    results: List[PhotoSearch]
+    next_page: Union[str, None]
+
+
+class SearchResultsVideo(BaseModel):
+    results: List[VideoSearch]
+    next_page: Union[str, None]

config_example.json

@@ -0,0 +1,34 @@
+{
+    "database": {
+        "name": "photos",
+        "host": "127.0.0.1",
+        "port": 27017,
+        "user": null,
+        "password": null
+    },
+    "messages": {
+        "email_confirmed": "Email confirmed. You can now log in."
+    },
+    "external_address": "localhost",
+    "media_token_access": false,
+    "media_token_valid_hours": 12,
+    "registration_enabled": true,
+    "registration_requires_confirmation": false,
+    "mailer": {
+        "smtp": {
+            "host": "",
+            "port": 0,
+            "sender": "",
+            "login": "",
+            "password": "",
+            "use_ssl": true,
+            "use_tls": false
+        },
+        "messages": {
+            "registration_confirmation": {
+                "subject": "Email confirmation",
+                "message": "To confirm your email please follow this link: {0}"
+            }
+        }
+    }
+}

dependencies.md

@@ -0,0 +1,7 @@
+# Dependecies
+
+In order to get compression to work you need to install following binaries and make them directly available on your machine:
+
+* exiftool
+* jpegoptim
+* optipng

extensions/albums.py

@@ -0,0 +1,227 @@
+import re
+from os import makedirs, path, rename
+from shutil import rmtree
+from typing import Union
+
+from bson.errors import InvalidId
+from bson.objectid import ObjectId
+from fastapi import Security
+from fastapi.responses import Response, UJSONResponse
+from starlette.status import HTTP_204_NO_CONTENT
+
+from classes.exceptions import (
+    AlbumAlreadyExistsError,
+    AlbumIncorrectError,
+    AlbumNotFoundError,
+)
+from classes.models import Album, AlbumModified, SearchResultsAlbum
+from modules.app import app
+from modules.database import col_albums, col_photos
+from modules.security import User, get_current_active_user
+
+album_create_responses = {
+    406: AlbumIncorrectError("name", "error").openapi,
+    409: AlbumAlreadyExistsError("name").openapi,
+}
+
+
+@app.post(
+    "/albums",
+    description="Create album with name and title",
+    response_class=UJSONResponse,
+    response_model=Album,
+    responses=album_create_responses,
+)
+async def album_create(
+    name: str,
+    title: str,
+    current_user: User = Security(get_current_active_user, scopes=["albums.write"]),
+):
+    if re.search(re.compile("^[a-z,0-9,_]*$"), name) is False:
+        raise AlbumIncorrectError("name", "can only contain a-z, 0-9 and _ characters.")
+
+    if 2 > len(name) > 20:
+        raise AlbumIncorrectError("name", "must be >2 and <20 characters.")
+
+    if 2 > len(title) > 40:
+        raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
+
+    if col_albums.find_one({"name": name}) is not None:
+        raise AlbumAlreadyExistsError(name)
+
+    makedirs(
+        path.join("data", "users", current_user.user, "albums", name), exist_ok=True
+    )
+
+    uploaded = col_albums.insert_one(
+        {"user": current_user.user, "name": name, "title": title, "cover": None}
+    )
+
+    return UJSONResponse(
+        {"id": uploaded.inserted_id.__str__(), "name": name, "title": title}
+    )
+
+
+@app.get("/albums", description="Find album by name", response_model=SearchResultsAlbum)
+async def album_find(
+    q: str,
+    current_user: User = Security(get_current_active_user, scopes=["albums.list"]),
+):
+    output = {"results": []}
+    albums = list(col_albums.find({"user": current_user.user, "name": re.compile(q)}))
+
+    for album in albums:
+        output["results"].append(
+            {
+                "id": album["_id"].__str__(),
+                "name": album["name"],
+                "title": album["title"],
+            }
+        )
+
+    return UJSONResponse(output)
+
+
+album_patch_responses = {
+    404: AlbumNotFoundError("id").openapi,
+    406: AlbumIncorrectError("name", "error").openapi,
+}
+
+
+@app.patch(
+    "/albums/{id}",
+    description="Modify album's name or title by id",
+    response_class=UJSONResponse,
+    response_model=AlbumModified,
+    responses=album_patch_responses,
+)
+async def album_patch(
+    id: str,
+    name: Union[str, None] = None,
+    title: Union[str, None] = None,
+    cover: Union[str, None] = None,
+    current_user: User = Security(get_current_active_user, scopes=["albums.write"]),
+):
+    try:
+        album = col_albums.find_one({"_id": ObjectId(id)})
+        if album is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise AlbumNotFoundError(id)
+
+    if title is not None:
+        if 2 > len(title) > 40:
+            raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
+    else:
+        title = album["title"]
+
+    if name is not None:
+        if re.search(re.compile("^[a-z,0-9,_]*$"), name) is False:
+            raise AlbumIncorrectError(
+                "name", "can only contain a-z, 0-9 and _ characters."
+            )
+        if 2 > len(name) > 20:
+            raise AlbumIncorrectError("name", "must be >2 and <20 characters.")
+        rename(
+            path.join("data", "users", current_user.user, "albums", album["name"]),
+            path.join("data", "users", current_user.user, "albums", name),
+        )
+        col_photos.update_many(
+            {"user": current_user.user, "album": album["name"]},
+            {"$set": {"album": name}},
+        )
+    else:
+        name = album["name"]
+
+    if cover is not None:
+        image = col_photos.find_one({"_id": ObjectId(cover), "album": album["name"]})
+        cover = image["_id"].__str__() if image is not None else album["cover"]
+    else:
+        cover = album["cover"]
+
+    col_albums.update_one(
+        {"_id": ObjectId(id)}, {"$set": {"name": name, "title": title, "cover": cover}}
+    )
+
+    return UJSONResponse({"name": name, "title": title, "cover": cover})
+
+
+album_put_responses = {
+    404: AlbumNotFoundError("id").openapi,
+    406: AlbumIncorrectError("name", "error").openapi,
+}
+
+
+@app.put(
+    "/albums/{id}",
+    description="Modify album's name and title by id",
+    response_class=UJSONResponse,
+    response_model=AlbumModified,
+    responses=album_put_responses,
+)
+async def album_put(
+    id: str,
+    name: str,
+    title: str,
+    cover: str,
+    current_user: User = Security(get_current_active_user, scopes=["albums.write"]),
+):
+    try:
+        album = col_albums.find_one({"_id": ObjectId(id)})
+        if album is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise AlbumNotFoundError(id)
+
+    if re.search(re.compile("^[a-z,0-9,_]*$"), name) is False:
+        raise AlbumIncorrectError("name", "can only contain a-z, 0-9 and _ characters.")
+
+    if 2 > len(name) > 20:
+        raise AlbumIncorrectError("name", "must be >2 and <20 characters.")
+
+    if 2 > len(title) > 40:
+        raise AlbumIncorrectError("title", "must be >2 and <40 characters.")
+
+    image = col_photos.find_one({"_id": ObjectId(cover), "album": album["name"]})
+    cover = image["_id"].__str__() if image is not None else None  # type: ignore
+
+    rename(
+        path.join("data", "users", current_user.user, "albums", album["name"]),
+        path.join("data", "users", current_user.user, "albums", name),
+    )
+
+    col_photos.update_many(
+        {"user": current_user.user, "album": album["name"]}, {"$set": {"album": name}}
+    )
+    col_albums.update_one(
+        {"_id": ObjectId(id)}, {"$set": {"name": name, "title": title, "cover": cover}}
+    )
+
+    return UJSONResponse({"name": name, "title": title, "cover": cover})
+
+
+album_delete_responses = {404: AlbumNotFoundError("id").openapi}
+
+
+@app.delete(
+    "/album/{id}",
+    description="Delete album by id",
+    status_code=HTTP_204_NO_CONTENT,
+    responses=album_delete_responses,
+)
+async def album_delete(
+    id: str,
+    current_user: User = Security(get_current_active_user, scopes=["albums.write"]),
+):
+    try:
+        album = col_albums.find_one_and_delete({"_id": ObjectId(id)})
+        if album is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise AlbumNotFoundError(id)
+
+    col_photos.delete_many({"album": album["name"]})
+
+    rmtree(path.join("data", "users", current_user.user, "albums", album["name"]))
+
+    return Response(status_code=HTTP_204_NO_CONTENT)

extensions/exceptions.py

@@ -0,0 +1,157 @@
+from fastapi import Request
+from fastapi.responses import UJSONResponse
+from starlette.status import (
+    HTTP_400_BAD_REQUEST,
+    HTTP_401_UNAUTHORIZED,
+    HTTP_404_NOT_FOUND,
+    HTTP_406_NOT_ACCEPTABLE,
+    HTTP_409_CONFLICT,
+    HTTP_422_UNPROCESSABLE_ENTITY,
+)
+
+from classes.exceptions import (
+    AlbumNotFoundError,
+    AlbumAlreadyExistsError,
+    AlbumIncorrectError,
+    PhotoNotFoundError,
+    PhotoSearchQueryEmptyError,
+    VideoNotFoundError,
+    VideoSearchQueryEmptyError,
+    SearchPageInvalidError,
+    SearchTokenInvalidError,
+    AccessTokenInvalidError,
+    UserEmailCodeInvalid,
+    UserAlreadyExists,
+    UserCredentialsInvalid,
+)
+from modules.app import app
+
+
+@app.exception_handler(AlbumNotFoundError)
+async def album_not_found_exception_handler(request: Request, exc: AlbumNotFoundError):
+    return UJSONResponse(
+        status_code=HTTP_404_NOT_FOUND,
+        content={"detail": f"Could not find album with id '{exc.id}'."},
+    )
+
+
+@app.exception_handler(AlbumAlreadyExistsError)
+async def album_already_exists_exception_handler(
+    request: Request, exc: AlbumAlreadyExistsError
+):
+    return UJSONResponse(
+        status_code=HTTP_409_CONFLICT,
+        content={"detail": f"Album with name '{exc.name}' already exists."},
+    )
+
+
+@app.exception_handler(AlbumIncorrectError)
+async def album_incorrect_exception_handler(request: Request, exc: AlbumIncorrectError):
+    return UJSONResponse(
+        status_code=HTTP_406_NOT_ACCEPTABLE,
+        content={"detail": f"Album {exc.place} invalid: {exc.error}"},
+    )
+
+
+@app.exception_handler(PhotoNotFoundError)
+async def photo_not_found_exception_handler(request: Request, exc: PhotoNotFoundError):
+    return UJSONResponse(
+        status_code=HTTP_404_NOT_FOUND,
+        content={"detail": f"Could not find photo with id '{exc.id}'."},
+    )
+
+
+@app.exception_handler(PhotoSearchQueryEmptyError)
+async def photo_search_query_empty_exception_handler(
+    request: Request, exc: PhotoSearchQueryEmptyError
+):
+    return UJSONResponse(
+        status_code=HTTP_422_UNPROCESSABLE_ENTITY,
+        content={
+            "detail": "You must provide query, caption or coordinates to look for photos."
+        },
+    )
+
+
+@app.exception_handler(VideoNotFoundError)
+async def video_not_found_exception_handler(request: Request, exc: VideoNotFoundError):
+    return UJSONResponse(
+        status_code=HTTP_404_NOT_FOUND,
+        content={"detail": f"Could not find video with id '{exc.id}'."},
+    )
+
+
+@app.exception_handler(VideoSearchQueryEmptyError)
+async def video_search_query_empty_exception_handler(
+    request: Request, exc: VideoSearchQueryEmptyError
+):
+    return UJSONResponse(
+        status_code=HTTP_422_UNPROCESSABLE_ENTITY,
+        content={
+            "detail": "You must provide query, caption or coordinates to look for photos."
+        },
+    )
+
+
+@app.exception_handler(SearchPageInvalidError)
+async def search_page_invalid_exception_handler(
+    request: Request, exc: SearchPageInvalidError
+):
+    return UJSONResponse(
+        status_code=HTTP_400_BAD_REQUEST,
+        content={
+            "detail": "Parameters 'page' and 'page_size' must be greater or equal to 1."
+        },
+    )
+
+
+@app.exception_handler(SearchTokenInvalidError)
+async def search_token_invalid_exception_handler(
+    request: Request, exc: SearchTokenInvalidError
+):
+    return UJSONResponse(
+        status_code=HTTP_401_UNAUTHORIZED,
+        content={
+            "detail": "Parameters 'page' and 'page_size' must be greater or equal to 1."
+        },
+    )
+
+
+@app.exception_handler(UserEmailCodeInvalid)
+async def user_email_code_invalid_exception_handler(
+    request: Request, exc: UserEmailCodeInvalid
+):
+    return UJSONResponse(
+        status_code=HTTP_400_BAD_REQUEST,
+        content={"detail": "Confirmation code is invalid."},
+    )
+
+
+@app.exception_handler(UserAlreadyExists)
+async def user_already_exists_exception_handler(
+    request: Request, exc: UserAlreadyExists
+):
+    return UJSONResponse(
+        status_code=HTTP_409_CONFLICT,
+        content={"detail": "User with this username already exists."},
+    )
+
+
+@app.exception_handler(AccessTokenInvalidError)
+async def access_token_invalid_exception_handler(
+    request: Request, exc: AccessTokenInvalidError
+):
+    return UJSONResponse(
+        status_code=HTTP_401_UNAUTHORIZED,
+        content={"detail": "Invalid access token."},
+    )
+
+
+@app.exception_handler(UserCredentialsInvalid)
+async def user_credentials_invalid_exception_handler(
+    request: Request, exc: UserCredentialsInvalid
+):
+    return UJSONResponse(
+        status_code=HTTP_401_UNAUTHORIZED,
+        content={"detail": "Invalid credentials."},
+    )

extensions/pages.py

@@ -0,0 +1,42 @@
+from os import path
+
+import aiofiles
+from fastapi.responses import HTMLResponse, Response
+
+from modules.app import app
+
+
+@app.get("/pages/matter.css", include_in_schema=False)
+async def page_matter():
+    async with aiofiles.open(
+        path.join("pages", "matter.css"), "r", encoding="utf-8"
+    ) as f:
+        output = await f.read()
+    return Response(content=output)
+
+
+@app.get("/pages/{page}/{file}", include_in_schema=False)
+async def page_assets(page: str, file: str):
+    async with aiofiles.open(
+        path.join("pages", page, file), "r", encoding="utf-8"
+    ) as f:
+        output = await f.read()
+    return Response(content=output)
+
+
+@app.get("/", include_in_schema=False)
+async def page_home():
+    async with aiofiles.open(
+        path.join("pages", "home", "index.html"), "r", encoding="utf-8"
+    ) as f:
+        output = await f.read()
+    return HTMLResponse(content=output)
+
+
+@app.get("/register", include_in_schema=False)
+async def page_register():
+    async with aiofiles.open(
+        path.join("pages", "register", "index.html"), "r", encoding="utf-8"
+    ) as f:
+        output = await f.read()
+    return HTMLResponse(content=output)

extensions/photos.py

@@ -0,0 +1,580 @@
+import re
+from datetime import datetime, timedelta, timezone
+from os import makedirs, path, remove, system
+from secrets import token_urlsafe
+from shutil import move
+from threading import Thread
+from typing import Union
+from uuid import uuid4
+
+import aiofiles
+from bson.errors import InvalidId
+from bson.objectid import ObjectId
+from fastapi import Security, UploadFile
+from fastapi.responses import Response, UJSONResponse
+from jose import JWTError, jwt
+from magic import Magic
+from plum.exceptions import UnpackError
+from pydantic import ValidationError
+from pymongo import DESCENDING
+from starlette.status import HTTP_204_NO_CONTENT, HTTP_409_CONFLICT
+
+from classes.exceptions import (
+    AccessTokenInvalidError,
+    AlbumNameNotFoundError,
+    PhotoNotFoundError,
+    PhotoSearchQueryEmptyError,
+    SearchPageInvalidError,
+    SearchTokenInvalidError,
+)
+from classes.models import Photo, PhotoPublic, SearchResultsPhoto
+from modules.app import app
+from modules.database import col_albums, col_photos, col_tokens
+from modules.exif_reader import extract_location
+from modules.hasher import get_duplicates, get_phash
+from modules.scheduler import scheduler
+from modules.security import (
+    ALGORITHM,
+    SECRET_KEY,
+    TokenData,
+    User,
+    create_access_token,
+    get_current_active_user,
+    get_user,
+)
+from modules.utils import configGet, logWrite
+
+
+async def compress_image(image_path: str):
+    image_type = Magic(mime=True).from_file(image_path)
+
+    if image_type not in ["image/jpeg", "image/png"]:
+        logWrite(f"Not compressing {image_path} because its mime is '{image_type}'")
+        return
+
+    size_before = path.getsize(image_path) / 1024
+
+    if image_type == "image/jpeg":
+        task = Thread(
+            target=system,
+            kwargs={"command": f'jpegoptim "{image_path}" -o --max=55 -p --strip-none'},
+        )
+    elif image_type == "image/png":
+        task = Thread(target=system, kwargs={"command": f'optipng -o3 "{image_path}"'})
+    else:
+        return
+
+    task.start()
+    logWrite(f"Compressing '{path.split(image_path)[-1]}'...")
+    task.join()
+
+    size_after = path.getsize(image_path) / 1024
+    logWrite(
+        f"Compressed '{path.split(image_path)[-1]}' from {size_before} Kb to {size_after} Kb"
+    )
+
+
+photo_post_responses = {
+    404: AlbumNameNotFoundError("name").openapi,
+    409: {
+        "description": "Image Duplicates Found",
+        "content": {
+            "application/json": {
+                "example": {
+                    "detail": "Image duplicates found. Pass 'ignore_duplicates=true' to ignore.",
+                    "duplicates": ["string"],
+                    "access_token": "string",
+                }
+            }
+        },
+    },
+}
+
+
+@app.post(
+    "/albums/{album}/photos",
+    description="Upload a photo to album",
+    response_class=UJSONResponse,
+    response_model=Photo,
+    responses=photo_post_responses,
+)
+async def photo_upload(
+    file: UploadFile,
+    album: str,
+    ignore_duplicates: bool = False,
+    compress: bool = True,
+    caption: Union[str, None] = None,
+    current_user: User = Security(get_current_active_user, scopes=["photos.write"]),
+):
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
+
+    makedirs(
+        path.join("data", "users", current_user.user, "albums", album), exist_ok=True
+    )
+
+    filename = file.filename
+
+    if path.exists(
+        path.join("data", "users", current_user.user, "albums", album, file.filename)
+    ):
+        base_name = file.filename.split(".")[:-1]
+        extension = file.filename.split(".")[-1]
+        filename = (
+            ".".join(base_name) + f"_{int(datetime.now().timestamp())}." + extension
+        )
+
+    async with aiofiles.open(
+        path.join("data", "users", current_user.user, "albums", album, filename), "wb"
+    ) as f:
+        f.write(await file.read())
+
+    file_hash = await get_phash(
+        path.join("data", "users", current_user.user, "albums", album, filename)
+    )
+    duplicates = await get_duplicates(file_hash, album)
+
+    if len(duplicates) > 0 and ignore_duplicates is False:
+        if configGet("media_token_access") is True:
+            duplicates_ids = []
+            for entry in duplicates:
+                duplicates_ids.append(entry["id"])
+            access_token = create_access_token(
+                data={
+                    "sub": current_user.user,
+                    "scopes": ["me", "photos.read"],
+                    "allowed": duplicates_ids,
+                },
+                expires_delta=timedelta(hours=configGet("media_token_valid_hours")),
+            )
+            access_token_short = uuid4().hex[:12].lower()
+            col_tokens.insert_one(
+                {
+                    "short": access_token_short,
+                    "access_token": access_token,
+                    "photos": duplicates_ids,
+                }
+            )
+        else:
+            access_token_short = None
+        return UJSONResponse(
+            {
+                "detail": "Image duplicates found. Pass 'ignore_duplicates=true' to ignore.",
+                "duplicates": duplicates,
+                "access_token": access_token_short,
+            },
+            status_code=HTTP_409_CONFLICT,
+        )
+
+    try:
+        coords = extract_location(
+            path.join("data", "users", current_user.user, "albums", album, filename)
+        )
+    except (UnpackError, ValueError):
+        coords = {"lng": 0.0, "lat": 0.0, "alt": 0.0}
+
+    uploaded = col_photos.insert_one(
+        {
+            "user": current_user.user,
+            "album": album,
+            "hash": file_hash,
+            "filename": filename,
+            "dates": {
+                "uploaded": datetime.now(tz=timezone.utc),
+                "modified": datetime.now(tz=timezone.utc),
+            },
+            "location": [coords["lng"], coords["lat"], coords["alt"]],
+            "caption": caption,
+        }
+    )
+
+    if compress is True:
+        scheduler.add_job(
+            compress_image,
+            trigger="date",
+            run_date=datetime.now() + timedelta(seconds=1),
+            args=[
+                path.join("data", "users", current_user.user, "albums", album, filename)
+            ],
+        )
+
+    return UJSONResponse(
+        {
+            "id": uploaded.inserted_id.__str__(),
+            "album": album,
+            "hash": file_hash,
+            "filename": filename,
+        }
+    )
+
+
+# Access to photos y token generated for example by
+# upload method when duplicates are found. Is disabled
+# by default and should remain so if not really needed.
+if configGet("media_token_access") is True:
+    photo_get_token_responses = {
+        401: AccessTokenInvalidError().openapi,
+        404: PhotoNotFoundError("id").openapi,
+    }
+
+    @app.get(
+        "/token/photo/{token}",
+        description="Get a photo by its duplicate token",
+        responses=photo_get_token_responses,
+    )
+    async def photo_get_token(token: str, id: int):
+        db_entry = col_tokens.find_one({"short": token})
+
+        if db_entry is None:
+            raise AccessTokenInvalidError()
+
+        token = db_entry["access_token"]
+        id = db_entry["photos"][id]
+
+        try:
+            payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
+            user: str = payload.get("sub")
+            if user is None:
+                raise AccessTokenInvalidError()
+            token_scopes = payload.get("scopes", [])
+            token_data = TokenData(scopes=token_scopes, user=user)
+        except (JWTError, ValidationError) as exp:
+            print(exp, flush=True)
+            raise AccessTokenInvalidError()
+
+        user = get_user(user=token_data.user)
+
+        if id not in payload.get("allowed", []):
+            raise AccessTokenInvalidError()
+
+        try:
+            image = col_photos.find_one({"_id": ObjectId(id)})
+            if image is None:
+                raise InvalidId(id)
+        except InvalidId:
+            raise PhotoNotFoundError(id)
+
+        image_path = path.join(
+            "data", "users", user.user, "albums", image["album"], image["filename"]
+        )
+
+        mime = Magic(mime=True).from_file(image_path)
+
+        async with aiofiles.open(image_path, "rb") as f:
+            image_file = await f.read()
+
+        return Response(image_file, media_type=mime)
+
+
+photo_get_responses = {
+    200: {"content": {"image/*": {}}},
+    404: PhotoNotFoundError("id").openapi,
+}
+
+
+@app.get(
+    "/photos/{id}",
+    description="Get a photo by id",
+    responses=photo_get_responses,
+    response_class=Response,
+)
+async def photo_get(
+    id: str,
+    current_user: User = Security(get_current_active_user, scopes=["photos.read"]),
+):
+    try:
+        image = col_photos.find_one({"_id": ObjectId(id)})
+        if image is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise PhotoNotFoundError(id)
+
+    image_path = path.join(
+        "data", "users", current_user.user, "albums", image["album"], image["filename"]
+    )
+
+    mime = Magic(mime=True).from_file(image_path)
+
+    async with aiofiles.open(image_path, "rb") as f:
+        image_file = await f.read()
+
+    return Response(image_file, media_type=mime)
+
+
+photo_move_responses = {404: PhotoNotFoundError("id").openapi}
+
+
+@app.put(
+    "/photos/{id}",
+    description="Move a photo to another album",
+    response_model=PhotoPublic,
+    responses=photo_move_responses,
+)
+async def photo_move(
+    id: str,
+    album: str,
+    current_user: User = Security(get_current_active_user, scopes=["photos.write"]),
+):
+    try:
+        image = col_photos.find_one({"_id": ObjectId(id)})
+        if image is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise PhotoNotFoundError(id)
+
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
+
+    if path.exists(
+        path.join(
+            "data", "users", current_user.user, "albums", album, image["filename"]
+        )
+    ):
+        base_name = image["filename"].split(".")[:-1]
+        extension = image["filename"].split(".")[-1]
+        filename = (
+            ".".join(base_name) + f"_{int(datetime.now().timestamp())}." + extension
+        )
+    else:
+        filename = image["filename"]
+
+    col_photos.find_one_and_update(
+        {"_id": ObjectId(id)},
+        {
+            "$set": {
+                "album": album,
+                "filename": filename,
+                "dates.modified": datetime.now(tz=timezone.utc),
+            }
+        },
+    )
+
+    move(
+        path.join(
+            "data",
+            "users",
+            current_user.user,
+            "albums",
+            image["album"],
+            image["filename"],
+        ),
+        path.join("data", "users", current_user.user, "albums", album, filename),
+    )
+
+    return UJSONResponse(
+        {
+            "id": image["_id"].__str__(),
+            "caption": image["caption"],
+            "filename": filename,
+        }
+    )
+
+
+photo_patch_responses = {404: PhotoNotFoundError("id").openapi}
+
+
+@app.patch(
+    "/photos/{id}",
+    description="Change properties of a photo",
+    response_model=PhotoPublic,
+    responses=photo_patch_responses,
+)
+async def photo_patch(
+    id: str,
+    caption: str,
+    current_user: User = Security(get_current_active_user, scopes=["photos.write"]),
+):
+    try:
+        image = col_photos.find_one({"_id": ObjectId(id)})
+        if image is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise PhotoNotFoundError(id)
+
+    col_photos.find_one_and_update(
+        {"_id": ObjectId(id)},
+        {"$set": {"caption": caption, "dates.modified": datetime.now(tz=timezone.utc)}},
+    )
+
+    return UJSONResponse(
+        {
+            "id": image["_id"].__str__(),
+            "caption": caption,
+            "filename": image["filename"],
+        }
+    )
+
+
+photo_delete_responses = {404: PhotoNotFoundError("id").openapi}
+
+
+@app.delete(
+    "/photos/{id}",
+    description="Delete a photo by id",
+    status_code=HTTP_204_NO_CONTENT,
+    responses=photo_delete_responses,
+)
+async def photo_delete(
+    id: str,
+    current_user: User = Security(get_current_active_user, scopes=["photos.write"]),
+):
+    try:
+        image = col_photos.find_one_and_delete({"_id": ObjectId(id)})
+        if image is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise PhotoNotFoundError(id)
+
+    album = col_albums.find_one({"name": image["album"]})
+
+    if album is not None and album["cover"] == image["_id"].__str__():
+        col_albums.update_one({"name": image["album"]}, {"$set": {"cover": None}})
+
+    remove(
+        path.join(
+            "data",
+            "users",
+            current_user.user,
+            "albums",
+            image["album"],
+            image["filename"],
+        )
+    )
+
+    return Response(status_code=HTTP_204_NO_CONTENT)
+
+
+photo_find_responses = {
+    400: SearchPageInvalidError().openapi,
+    401: SearchTokenInvalidError().openapi,
+    404: AlbumNameNotFoundError("name").openapi,
+    422: PhotoSearchQueryEmptyError().openapi,
+}
+
+
+@app.get(
+    "/albums/{album}/photos",
+    description="Find a photo by filename, caption, location or token",
+    response_class=UJSONResponse,
+    response_model=SearchResultsPhoto,
+    responses=photo_find_responses,
+)
+async def photo_find(
+    album: str,
+    q: Union[str, None] = None,
+    caption: Union[str, None] = None,
+    token: Union[str, None] = None,
+    page: int = 1,
+    page_size: int = 100,
+    lat: Union[float, None] = None,
+    lng: Union[float, None] = None,
+    radius: Union[int, None] = None,
+    current_user: User = Security(get_current_active_user, scopes=["photos.list"]),
+):
+    if token is not None:
+        found_record = col_tokens.find_one({"token": token})
+
+        if found_record is None:
+            raise SearchTokenInvalidError()
+
+        return await photo_find(
+            album=album,
+            q=found_record["query"],
+            caption=found_record["caption"],
+            lat=found_record["lat"],
+            lng=found_record["lng"],
+            radius=found_record["radius"],
+            page=found_record["page"],
+            page_size=found_record["page_size"],
+            current_user=current_user,
+        )
+
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
+
+    if page <= 0 or page_size <= 0:
+        raise SearchPageInvalidError()
+
+    output = {"results": []}
+    skip = (page - 1) * page_size
+
+    radius = 5000 if radius is None else radius
+
+    if (lat is not None) and (lng is not None):
+        db_query = {
+            "user": current_user.user,
+            "album": album,
+            "location": {
+                "$nearSphere": {
+                    "$geometry": {"type": "Point", "coordinates": [lng, lat]},
+                    "$maxDistance": radius,
+                }
+            },
+        }
+        db_query_count = {
+            "user": current_user.user,
+            "album": album,
+            "location": {"$geoWithin": {"$centerSphere": [[lng, lat], radius]}},
+        }
+    elif q is None and caption is None:
+        raise PhotoSearchQueryEmptyError()
+    elif q is None and caption is not None:
+        db_query = {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+        db_query_count = {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+    elif q is not None and caption is None:
+        db_query = {
+            "user": current_user.user,
+            "album": album,
+            "filename": re.compile(q),
+        }
+        db_query_count = {
+            "user": current_user.user,
+            "album": album,
+            "filename": re.compile(q),
+        }
+    else:
+        db_query = {"user": current_user.user, "album": album, "filename": re.compile(q), "caption": re.compile(caption)}  # type: ignore
+        db_query_count = {"user": current_user.user, "album": album, "filename": re.compile(q), "caption": re.compile(caption)}  # type: ignore
+
+    images = list(
+        col_photos.find(db_query, limit=page_size, skip=skip).sort(
+            "dates.uploaded", DESCENDING
+        )
+    )
+
+    for image in images:
+        output["results"].append(
+            {
+                "id": image["_id"].__str__(),
+                "filename": image["filename"],
+                "caption": image["caption"],
+            }
+        )
+
+    if col_photos.count_documents(db_query_count) > page * page_size:
+        token = str(token_urlsafe(32))
+        col_tokens.insert_one(
+            {
+                "token": token,
+                "query": q,
+                "caption": caption,
+                "lat": lat,
+                "lng": lng,
+                "radius": radius,
+                "page": page + 1,
+                "page_size": page_size,
+            }
+        )
+        output["next_page"] = f"/albums/{album}/photos/?token={token}"  # type: ignore
+    else:
+        output["next_page"] = None  # type: ignore
+
+    return UJSONResponse(output)

extensions/security.py

@@ -0,0 +1,28 @@
+from datetime import timedelta
+
+from fastapi import Depends
+from fastapi.security import OAuth2PasswordRequestForm
+
+from classes.exceptions import UserCredentialsInvalid
+from modules.app import app
+from modules.security import (
+    ACCESS_TOKEN_EXPIRE_DAYS,
+    Token,
+    authenticate_user,
+    create_access_token,
+)
+
+token_post_responses = {401: UserCredentialsInvalid().openapi}
+
+
+@app.post("/token", response_model=Token, responses=token_post_responses)
+async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
+    user = authenticate_user(form_data.username, form_data.password)
+    if not user:
+        raise UserCredentialsInvalid()
+    access_token_expires = timedelta(days=ACCESS_TOKEN_EXPIRE_DAYS)
+    access_token = create_access_token(
+        data={"sub": user.user, "scopes": form_data.scopes},
+        expires_delta=access_token_expires,
+    )
+    return {"access_token": access_token, "token_type": "bearer"}

extensions/users.py

@@ -0,0 +1,140 @@
+from datetime import datetime, timedelta
+from uuid import uuid1
+
+from fastapi import Depends, Form
+from fastapi.responses import Response, UJSONResponse
+from starlette.status import HTTP_204_NO_CONTENT
+
+from classes.exceptions import (
+    UserAlreadyExists,
+    UserCredentialsInvalid,
+    UserEmailCodeInvalid,
+)
+from modules.app import app
+from modules.database import col_albums, col_emails, col_photos, col_users, col_videos
+from modules.mailer import mail_sender
+from modules.scheduler import scheduler
+from modules.security import (
+    User,
+    get_current_active_user,
+    get_password_hash,
+    get_user,
+    verify_password,
+)
+from modules.utils import configGet, logWrite
+
+
+async def send_confirmation(user: str, email: str):
+    confirmation_code = str(uuid1())
+    try:
+        mail_sender.sendmail(
+            from_addr=configGet("sender", "mailer", "smtp"),
+            to_addrs=email,
+            msg=f'From: {configGet("sender", "mailer", "smtp")}\nSubject: Email confirmation\n\n'
+            + configGet(
+                "message", "mailer", "messages", "registration_confirmation"
+            ).format(
+                configGet("external_address")
+                + f"/users/{user}/confirm?code={confirmation_code}"
+            ),
+        )
+        col_emails.insert_one(
+            {"user": user, "email": email, "used": False, "code": confirmation_code}
+        )
+        logWrite(f"Sent confirmation email to '{email}' with code {confirmation_code}")
+    except Exception as exp:
+        logWrite(f"Could not send confirmation email to '{email}' due to: {exp}")
+
+
+@app.get("/users/me/", response_model=User)
+async def user_me(current_user: User = Depends(get_current_active_user)):
+    return current_user
+
+
+user_confirm_responses = {
+    200: {
+        "description": "Successful Response",
+        "content": {
+            "application/json": {
+                "example": {"detail": configGet("email_confirmed", "messages")}
+            }
+        },
+    },
+    400: UserEmailCodeInvalid().openapi,
+}
+if configGet("registration_requires_confirmation") is True:
+
+    @app.get(
+        "/users/{user}/confirm",
+        response_class=UJSONResponse,
+        responses=user_confirm_responses,
+    )
+    @app.patch(
+        "/users/{user}/confirm",
+        response_class=UJSONResponse,
+        responses=user_confirm_responses,
+    )
+    async def user_confirm(user: str, code: str):
+        confirm_record = col_emails.find_one(
+            {"user": user, "code": code, "used": False}
+        )
+        if confirm_record is None:
+            raise UserEmailCodeInvalid()
+        col_emails.find_one_and_update(
+            {"_id": confirm_record["_id"]}, {"$set": {"used": True}}
+        )
+        col_users.find_one_and_update(
+            {"user": confirm_record["user"]}, {"$set": {"disabled": False}}
+        )
+        return UJSONResponse({"detail": configGet("email_confirmed", "messages")})
+
+
+user_create_responses = {409: UserAlreadyExists().openapi}
+if configGet("registration_enabled") is True:
+
+    @app.post(
+        "/users", status_code=HTTP_204_NO_CONTENT, responses=user_create_responses
+    )
+    async def user_create(
+        user: str = Form(), email: str = Form(), password: str = Form()
+    ):
+        if col_users.find_one({"user": user}) is not None:
+            raise UserAlreadyExists()
+        col_users.insert_one(
+            {
+                "user": user,
+                "email": email,
+                "hash": get_password_hash(password),
+                "disabled": configGet("registration_requires_confirmation"),
+            }
+        )
+        if configGet("registration_requires_confirmation") is True:
+            scheduler.add_job(
+                send_confirmation,
+                trigger="date",
+                run_date=datetime.now() + timedelta(seconds=1),
+                kwargs={"user": user, "email": email},
+            )
+        return Response(status_code=HTTP_204_NO_CONTENT)
+
+
+user_delete_responses = {401: UserCredentialsInvalid().openapi}
+
+
+@app.delete(
+    "/users/me/", status_code=HTTP_204_NO_CONTENT, responses=user_delete_responses
+)
+async def user_delete(
+    password: str = Form(), current_user: User = Depends(get_current_active_user)
+):
+    user = get_user(current_user.user)
+    if not user:
+        return False
+    if not verify_password(password, user.hash):
+        raise UserCredentialsInvalid()
+    col_users.delete_many({"user": current_user.user})
+    col_emails.delete_many({"user": current_user.user})
+    col_photos.delete_many({"user": current_user.user})
+    col_videos.delete_many({"user": current_user.user})
+    col_albums.delete_many({"user": current_user.user})
+    return Response(status_code=HTTP_204_NO_CONTENT)

extensions/videos.py

@@ -0,0 +1,379 @@
+import re
+from datetime import datetime, timezone
+from os import makedirs, path, remove
+from secrets import token_urlsafe
+from shutil import move
+from typing import Union
+
+import aiofiles
+from bson.errors import InvalidId
+from bson.objectid import ObjectId
+from fastapi import Security, UploadFile
+from fastapi.responses import Response, UJSONResponse
+from magic import Magic
+from pymongo import DESCENDING
+from starlette.status import HTTP_204_NO_CONTENT
+
+from classes.exceptions import (
+    AlbumNameNotFoundError,
+    SearchPageInvalidError,
+    SearchTokenInvalidError,
+    VideoNotFoundError,
+    VideoSearchQueryEmptyError,
+)
+from classes.models import SearchResultsVideo, Video, VideoPublic
+from modules.app import app
+from modules.database import col_albums, col_tokens, col_videos
+from modules.security import User, get_current_active_user
+
+video_post_responses = {404: AlbumNameNotFoundError("name").openapi}
+
+
+@app.post(
+    "/albums/{album}/videos",
+    description="Upload a video to album",
+    response_class=UJSONResponse,
+    response_model=Video,
+    responses=video_post_responses,
+)
+async def video_upload(
+    file: UploadFile,
+    album: str,
+    caption: Union[str, None] = None,
+    current_user: User = Security(get_current_active_user, scopes=["videos.write"]),
+):
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
+
+    makedirs(
+        path.join("data", "users", current_user.user, "albums", album), exist_ok=True
+    )
+
+    filename = file.filename
+
+    if path.exists(
+        path.join("data", "users", current_user.user, "albums", album, file.filename)
+    ):
+        base_name = file.filename.split(".")[:-1]
+        extension = file.filename.split(".")[-1]
+        filename = (
+            ".".join(base_name) + f"_{int(datetime.now().timestamp())}." + extension
+        )
+
+    async with aiofiles.open(
+        path.join("data", "users", current_user.user, "albums", album, filename), "wb"
+    ) as f:
+        await f.write(await file.read())
+
+    # Hashing and duplicates check should be here
+
+    # Coords extraction should be here
+
+    uploaded = col_videos.insert_one(
+        {
+            "user": current_user.user,
+            "album": album,
+            "filename": filename,
+            "dates": {
+                "uploaded": datetime.now(tz=timezone.utc),
+                "modified": datetime.now(tz=timezone.utc),
+            },
+            "caption": caption,
+        }
+    )
+
+    return UJSONResponse(
+        {
+            "id": uploaded.inserted_id.__str__(),
+            "album": album,
+            "hash": "",  # SHOULD BE DONE
+            "filename": filename,
+        }
+    )
+
+
+video_get_responses = {
+    200: {"content": {"video/*": {}}},
+    404: VideoNotFoundError("id").openapi,
+}
+
+
+@app.get(
+    "/videos/{id}",
+    description="Get a video by id",
+    responses=video_get_responses,
+    response_class=Response,
+)
+async def video_get(
+    id: str,
+    current_user: User = Security(get_current_active_user, scopes=["videos.read"]),
+):
+    try:
+        video = col_videos.find_one({"_id": ObjectId(id)})
+        if video is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise VideoNotFoundError(id)
+
+    video_path = path.join(
+        "data", "users", current_user.user, "albums", video["album"], video["filename"]
+    )
+
+    mime = Magic(mime=True).from_file(video_path)
+
+    async with aiofiles.open(video_path, "rb") as f:
+        video_file = await f.read()
+
+    return Response(content=video_file, media_type=mime)
+
+
+video_move_responses = {404: VideoNotFoundError("id").openapi}
+
+
+@app.put(
+    "/videos/{id}",
+    description="Move a video into another album",
+    response_model=VideoPublic,
+    responses=video_move_responses,
+)
+async def video_move(
+    id: str,
+    album: str,
+    current_user: User = Security(get_current_active_user, scopes=["videos.write"]),
+):
+    try:
+        video = col_videos.find_one({"_id": ObjectId(id)})
+        if video is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise VideoNotFoundError(id)
+
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
+
+    if path.exists(
+        path.join(
+            "data", "users", current_user.user, "albums", album, video["filename"]
+        )
+    ):
+        base_name = video["filename"].split(".")[:-1]
+        extension = video["filename"].split(".")[-1]
+        filename = (
+            ".".join(base_name) + f"_{int(datetime.now().timestamp())}." + extension
+        )
+    else:
+        filename = video["filename"]
+
+    col_videos.find_one_and_update(
+        {"_id": ObjectId(id)},
+        {
+            "$set": {
+                "album": album,
+                "filename": filename,
+                "dates.modified": datetime.now(tz=timezone.utc),
+            }
+        },
+    )
+
+    move(
+        path.join(
+            "data",
+            "users",
+            current_user.user,
+            "albums",
+            video["album"],
+            video["filename"],
+        ),
+        path.join("data", "users", current_user.user, "albums", album, filename),
+    )
+
+    return UJSONResponse(
+        {
+            "id": video["_id"].__str__(),
+            "caption": video["caption"],
+            "filename": filename,
+        }
+    )
+
+
+video_patch_responses = {404: VideoNotFoundError("id").openapi}
+
+
+@app.patch(
+    "/videos/{id}",
+    description="Change properties of a video",
+    response_model=VideoPublic,
+    responses=video_patch_responses,
+)
+async def video_patch(
+    id: str,
+    caption: str,
+    current_user: User = Security(get_current_active_user, scopes=["videos.write"]),
+):
+    try:
+        video = col_videos.find_one({"_id": ObjectId(id)})
+        if video is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise VideoNotFoundError(id)
+
+    col_videos.find_one_and_update(
+        {"_id": ObjectId(id)},
+        {"$set": {"caption": caption, "dates.modified": datetime.now(tz=timezone.utc)}},
+    )
+
+    return UJSONResponse(
+        {
+            "id": video["_id"].__str__(),
+            "caption": video["caption"],
+            "filename": video["filename"],
+        }
+    )
+
+
+video_delete_responses = {404: VideoNotFoundError("id").openapi}
+
+
+@app.delete(
+    "/videos/{id}",
+    description="Delete a video by id",
+    status_code=HTTP_204_NO_CONTENT,
+    responses=video_delete_responses,
+)
+async def video_delete(
+    id: str,
+    current_user: User = Security(get_current_active_user, scopes=["videos.write"]),
+):
+    try:
+        video = col_videos.find_one_and_delete({"_id": ObjectId(id)})
+        if video is None:
+            raise InvalidId(id)
+    except InvalidId:
+        raise VideoNotFoundError(id)
+
+    album = col_albums.find_one({"name": video["album"]})
+
+    remove(
+        path.join(
+            "data",
+            "users",
+            current_user.user,
+            "albums",
+            video["album"],
+            video["filename"],
+        )
+    )
+
+    return Response(status_code=HTTP_204_NO_CONTENT)
+
+
+video_find_responses = {
+    400: SearchPageInvalidError().openapi,
+    401: SearchTokenInvalidError().openapi,
+    404: AlbumNameNotFoundError("name").openapi,
+    422: VideoSearchQueryEmptyError().openapi,
+}
+
+
+@app.get(
+    "/albums/{album}/videos",
+    description="Find a video by filename, caption or token",
+    response_class=UJSONResponse,
+    response_model=SearchResultsVideo,
+    responses=video_find_responses,
+)
+async def video_find(
+    album: str,
+    q: Union[str, None] = None,
+    caption: Union[str, None] = None,
+    token: Union[str, None] = None,
+    page: int = 1,
+    page_size: int = 100,
+    current_user: User = Security(get_current_active_user, scopes=["videos.list"]),
+):
+    if token is not None:
+        found_record = col_tokens.find_one({"token": token})
+
+        if found_record is None:
+            raise SearchTokenInvalidError()
+
+        return await video_find(
+            album=album,
+            q=found_record["query"],
+            caption=found_record["caption"],
+            page=found_record["page"],
+            page_size=found_record["page_size"],
+            current_user=current_user,
+        )
+
+    if col_albums.find_one({"user": current_user.user, "name": album}) is None:
+        raise AlbumNameNotFoundError(album)
+
+    if page <= 0 or page_size <= 0:
+        raise SearchPageInvalidError()
+
+    output = {"results": []}
+    skip = (page - 1) * page_size
+
+    if q is None and caption is None:
+        raise VideoSearchQueryEmptyError()
+
+    if q is None and caption is not None:
+        db_query = {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+        db_query_count = {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(caption),
+        }
+    elif q is not None and caption is None:
+        db_query = list(
+            col_videos.find(
+                {"user": current_user.user, "album": album, "filename": re.compile(q)},
+                limit=page_size,
+                skip=skip,
+            ).sort("dates.uploaded", DESCENDING)
+        )
+        db_query_count = {
+            "user": current_user.user,
+            "album": album,
+            "caption": re.compile(q),
+        }
+    else:
+        db_query = list(col_videos.find({"user": current_user.user, "album": album, "filename": re.compile(q), "caption": re.compile(caption)}, limit=page_size, skip=skip).sort("dates.uploaded", DESCENDING))  # type: ignore
+        db_query_count = {"user": current_user.user, "album": album, "filename": re.compile(q), "caption": re.compile(caption)}  # type: ignore
+
+    videos = list(
+        col_videos.find(db_query, limit=page_size, skip=skip).sort(
+            "dates.uploaded", DESCENDING
+        )
+    )
+
+    for video in videos:
+        output["results"].append(
+            {
+                "id": video["_id"].__str__(),
+                "filename": video["filename"],
+                "caption": video["caption"],
+            }
+        )
+
+    if col_videos.count_documents(db_query_count) > page * page_size:
+        token = str(token_urlsafe(32))
+        col_tokens.insert_one(
+            {
+                "token": token,
+                "query": q,
+                "caption": caption,
+                "page": page + 1,
+                "page_size": page_size,
+            }
+        )
+        output["next_page"] = f"/albums/{album}/videos/?token={token}"  # type: ignore
+    else:
+        output["next_page"] = None  # type: ignore
+
+    return UJSONResponse(output)

modules/app.py

@@ -0,0 +1,22 @@
+from fastapi import FastAPI
+from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
+
+app = FastAPI(title="END PLAY Photos", docs_url=None, redoc_url=None, version="0.3")
+
+
+@app.get("/docs", include_in_schema=False)
+async def custom_swagger_ui_html():
+    return get_swagger_ui_html(
+        openapi_url=app.openapi_url,  # type: ignore
+        title=app.title + " - Documentation",
+        swagger_favicon_url="/favicon.ico",
+    )
+
+
+@app.get("/redoc", include_in_schema=False)
+async def custom_redoc_html():
+    return get_redoc_html(
+        openapi_url=app.openapi_url,  # type: ignore
+        title=app.title + " - Documentation",
+        redoc_favicon_url="/favicon.ico",
+    )

modules/database.py

@@ -0,0 +1,37 @@
+from pymongo import GEOSPHERE, MongoClient
+
+from modules.utils import configGet
+
+db_config = configGet("database")
+
+if db_config["user"] is not None and db_config["password"] is not None:
+    con_string = "mongodb://{0}:{1}@{2}:{3}/{4}".format(
+        db_config["user"],
+        db_config["password"],
+        db_config["host"],
+        db_config["port"],
+        db_config["name"],
+    )
+else:
+    con_string = "mongodb://{0}:{1}/{2}".format(
+        db_config["host"], db_config["port"], db_config["name"]
+    )
+
+db_client = MongoClient(con_string)
+
+db = db_client.get_database(name=db_config["name"])
+
+collections = db.list_collection_names()
+
+for collection in ["users", "albums", "photos", "videos", "tokens", "emails"]:
+    if not collection in collections:
+        db.create_collection(collection)
+
+col_users = db.get_collection("users")
+col_albums = db.get_collection("albums")
+col_photos = db.get_collection("photos")
+col_videos = db.get_collection("videos")
+col_tokens = db.get_collection("tokens")
+col_emails = db.get_collection("emails")
+
+col_photos.create_index([("location", GEOSPHERE)])

modules/exif_reader.py

@@ -0,0 +1,45 @@
+from exif import Image
+
+
+def decimal_coords(coords: float, ref: str) -> float:
+    """Get latitude/longitude from coord and direction reference
+
+    ### Args:
+        * coords (`float`): _description_
+        * ref (`str`): _description_
+
+    ### Returns:
+        * float: Decimal degrees
+    """
+    decimal_degrees = coords[0] + coords[1] / 60 + coords[2] / 3600
+    if ref == "S" or ref == "W":
+        decimal_degrees = -decimal_degrees
+    return round(decimal_degrees, 5)
+
+
+def extract_location(filepath: str) -> dict:
+    """Get location data from image
+
+    ### Args:
+        * filepath (`str`): Path to file location
+
+    ### Returns:
+        * dict: `{ "lng": float, "lat": float, "alt": float }`
+    """
+
+    output = {"lng": 0.0, "lat": 0.0, "alt": 0.0}
+
+    with open(filepath, "rb") as src:
+        img = Image(src)
+
+    if img.has_exif is False:
+        return output
+
+    try:
+        output["lng"] = decimal_coords(img.gps_longitude, img.gps_longitude_ref)
+        output["lat"] = decimal_coords(img.gps_latitude, img.gps_latitude_ref)
+        output["alt"] = img.gps_altitude
+    except AttributeError:
+        pass
+
+    return output

modules/extensions_loader.py

@@ -0,0 +1,52 @@
+from importlib.util import module_from_spec, spec_from_file_location
+from os import getcwd, path, walk
+
+# =================================================================================
+
+
+# Import functions
+# Took from https://stackoverflow.com/a/57892961
+def get_py_files(src):
+    cwd = getcwd()  # Current Working directory
+    py_files = []
+    for root, dirs, files in walk(src):
+        for file in files:
+            if file.endswith(".py"):
+                py_files.append(path.join(cwd, root, file))
+    return py_files
+
+
+def dynamic_import(module_name, py_path):
+    try:
+        module_spec = spec_from_file_location(module_name, py_path)
+        module = module_from_spec(module_spec)  # type: ignore
+        module_spec.loader.exec_module(module)  # type: ignore
+        return module
+    except SyntaxError:
+        print(
+            f"Could not load extension {module_name} due to invalid syntax. Check logs/errors.log for details.",
+            flush=True,
+        )
+        return
+    except Exception as exp:
+        print(f"Could not load extension {module_name} due to {exp}", flush=True)
+        return
+
+
+def dynamic_import_from_src(src, star_import=False):
+    my_py_files = get_py_files(src)
+    for py_file in my_py_files:
+        module_name = path.split(py_file)[-1][:-3]
+        print(f"Importing {module_name} extension...", flush=True)
+        imported_module = dynamic_import(module_name, py_file)
+        if imported_module != None:
+            if star_import:
+                for obj in dir(imported_module):
+                    globals()[obj] = imported_module.__dict__[obj]
+            else:
+                globals()[module_name] = imported_module
+        print(f"Successfully loaded {module_name} extension", flush=True)
+    return
+
+
+# =================================================================================

modules/hasher.py

@@ -0,0 +1,72 @@
+import cv2
+import numpy as np
+from numpy.typing import NDArray
+from scipy import spatial
+
+from modules.database import col_photos
+
+
+def hash_array_to_hash_hex(hash_array):
+    # convert hash array of 0 or 1 to hash string in hex
+    hash_array = np.array(hash_array, dtype=np.uint8)
+    hash_str = "".join(str(i) for i in 1 * hash_array.flatten())
+    return hex(int(hash_str, 2))
+
+
+def hash_hex_to_hash_array(hash_hex) -> NDArray:
+    # convert hash string in hex to hash values of 0 or 1
+    hash_str = int(hash_hex, 16)
+    array_str = bin(hash_str)[2:]
+    return np.array([i for i in array_str], dtype=np.float32)
+
+
+def get_duplicates_cache(album: str) -> dict:
+    output = {}
+    for photo in col_photos.find({"album": album}):
+        output[photo["filename"]] = [photo["_id"].__str__(), photo["hash"]]
+    return output
+
+
+async def get_phash(filepath: str) -> str:
+    img = cv2.imread(filepath)
+    # resize image and convert to gray scale
+    img = cv2.resize(img, (64, 64))
+    img = cv2.cvtColor(img, cv2.COLOR_BGR2GRAY)
+    img = np.array(img, dtype=np.float32)
+    # calculate dct of image
+    dct = cv2.dct(img)
+    # to reduce hash length take only 8*8 top-left block
+    # as this block has more information than the rest
+    dct_block = dct[:8, :8]
+    # caclulate mean of dct block excluding first term i.e, dct(0, 0)
+    dct_average = (dct_block.mean() * dct_block.size - dct_block[0, 0]) / (
+        dct_block.size - 1
+    )
+    # convert dct block to binary values based on dct_average
+    dct_block[dct_block < dct_average] = 0.0
+    dct_block[dct_block != 0] = 1.0
+    # store hash value
+    return hash_array_to_hash_hex(dct_block.flatten())
+
+
+async def get_duplicates(hash: str, album: str) -> list:
+    duplicates = []
+    cache = get_duplicates_cache(album)
+    for image_name in cache.keys():
+        try:
+            distance = spatial.distance.hamming(
+                hash_hex_to_hash_array(cache[image_name][1]),
+                hash_hex_to_hash_array(hash),
+            )
+        except ValueError:
+            continue
+        # print("{0:<30} {1}".format(image_name, distance), flush=True)
+        if distance <= 0.1:
+            duplicates.append(
+                {
+                    "id": cache[image_name][0],
+                    "filename": image_name,
+                    "difference": distance,
+                }
+            )
+    return duplicates

modules/mailer.py

@@ -0,0 +1,38 @@
+from smtplib import SMTP, SMTP_SSL
+from ssl import create_default_context
+from traceback import print_exc
+
+from modules.utils import configGet, logWrite
+
+try:
+    if configGet("use_ssl", "mailer", "smtp") is True:
+        mail_sender = SMTP_SSL(
+            configGet("host", "mailer", "smtp"),
+            configGet("port", "mailer", "smtp"),
+        )
+        logWrite(f"Initialized SMTP SSL connection")
+    elif configGet("use_tls", "mailer", "smtp") is True:
+        mail_sender = SMTP(
+            configGet("host", "mailer", "smtp"),
+            configGet("port", "mailer", "smtp"),
+        )
+        mail_sender.starttls(context=create_default_context())
+        mail_sender.ehlo()
+        logWrite(f"Initialized SMTP TLS connection")
+    else:
+        mail_sender = SMTP(
+            configGet("host", "mailer", "smtp"), configGet("port", "mailer", "smtp")
+        )
+        mail_sender.ehlo()
+        logWrite(f"Initialized SMTP connection")
+except Exception as exp:
+    logWrite(f"Could not initialize SMTP connection to: {exp}")
+    print_exc()
+
+try:
+    mail_sender.login(
+        configGet("login", "mailer", "smtp"), configGet("password", "mailer", "smtp")
+    )
+    logWrite(f"Successfully initialized mailer")
+except Exception as exp:
+    logWrite(f"Could not login into provided SMTP account due to: {exp}")

modules/scheduler.py

@@ -0,0 +1,3 @@
+from apscheduler.schedulers.asyncio import AsyncIOScheduler
+
+scheduler = AsyncIOScheduler()

modules/security.py

@@ -0,0 +1,141 @@
+from datetime import datetime, timedelta, timezone
+from typing import List, Union
+
+from fastapi import Depends, HTTPException, Security, status
+from fastapi.security import OAuth2PasswordBearer, SecurityScopes
+from jose import JWTError, jwt
+from passlib.context import CryptContext
+from pydantic import BaseModel, ValidationError
+
+from modules.database import col_users
+
+with open("secret_key", "r", encoding="utf-8") as f:
+    SECRET_KEY = f.read()
+ALGORITHM = "HS256"
+ACCESS_TOKEN_EXPIRE_DAYS = 180
+
+
+class Token(BaseModel):
+    access_token: str
+    token_type: str
+
+
+class TokenData(BaseModel):
+    user: Union[str, None] = None
+    scopes: List[str] = []
+
+
+class User(BaseModel):
+    user: str
+    email: Union[str, None] = None
+    disabled: Union[bool, None] = None
+
+
+class UserInDB(User):
+    hash: str
+
+
+pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
+
+oauth2_scheme = OAuth2PasswordBearer(
+    tokenUrl="token",
+    scopes={
+        "me": "Get current user's data.",
+        "albums.list": "List albums.",
+        "albums.read": "Read albums data.",
+        "albums.write": "Modify albums.",
+        "photos.list": "List photos.",
+        "photos.read": "View photos.",
+        "photos.write": "Modify photos.",
+        "videos.list": "List videos.",
+        "videos.read": "View videos.",
+        "videos.write": "Modify videos.",
+    },
+)
+
+
+def verify_password(plain_password, hashed_password):
+    return pwd_context.verify(plain_password, hashed_password)
+
+
+def get_password_hash(password):
+    return pwd_context.hash(password)
+
+
+def get_user(user: str):
+    found_user = col_users.find_one({"user": user})
+    return UserInDB(
+        user=found_user["user"],
+        email=found_user["email"],
+        disabled=found_user["disabled"],
+        hash=found_user["hash"],
+    )
+
+
+def authenticate_user(user_name: str, password: str):
+    user = get_user(user_name)
+    if not user:
+        return False
+    if not verify_password(password, user.hash):
+        return False
+    return user
+
+
+def create_access_token(data: dict, expires_delta: Union[timedelta, None] = None):
+    to_encode = data.copy()
+    if expires_delta:
+        expire = datetime.now(tz=timezone.utc) + expires_delta
+    else:
+        expire = datetime.now(tz=timezone.utc) + timedelta(
+            days=ACCESS_TOKEN_EXPIRE_DAYS
+        )
+    to_encode.update({"exp": expire})
+    encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
+    return encoded_jwt
+
+
+async def get_current_user(
+    security_scopes: SecurityScopes, token: str = Depends(oauth2_scheme)
+):
+    if security_scopes.scopes:
+        authenticate_value = f'Bearer scope="{security_scopes.scope_str}"'
+    else:
+        authenticate_value = "Bearer"
+
+    credentials_exception = HTTPException(
+        status_code=status.HTTP_401_UNAUTHORIZED,
+        detail="Could not validate credentials",
+        headers={"WWW-Authenticate": authenticate_value},
+    )
+
+    try:
+        payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
+        user: str = payload.get("sub")
+        if user is None:
+            raise credentials_exception
+        token_scopes = payload.get("scopes", [])
+        token_data = TokenData(scopes=token_scopes, user=user)
+    except (JWTError, ValidationError):
+        raise credentials_exception
+
+    user = get_user(user=token_data.user)
+
+    if user is None:
+        raise credentials_exception
+
+    for scope in security_scopes.scopes:
+        if scope not in token_data.scopes:
+            raise HTTPException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail="Not enough permissions",
+                headers={"WWW-Authenticate": authenticate_value},
+            )
+    return user
+
+
+async def get_current_active_user(
+    current_user: User = Security(get_current_user, scopes=["me"])
+):
+    if current_user.disabled:
+        raise HTTPException(status_code=400, detail="Inactive user")
+    return current_user

modules/utils.py

@@ -0,0 +1,86 @@
+from traceback import print_exc
+from typing import Any, Union
+
+from ujson import JSONDecodeError, dumps, loads
+
+
+# Print to stdout and then to log
+def logWrite(message: str, debug: bool = False) -> None:
+    # save to log file and rotation is to be done
+    # logAppend(f'{message}', debug=debug)
+    print(f"{message}", flush=True)
+
+
+def jsonLoad(filepath: str) -> Any:
+    """Load json file
+
+    ### Args:
+        * filepath (`str`): Path to input file
+
+    ### Returns:
+        * `Any`: Some json deserializable
+    """
+    with open(filepath, "r", encoding="utf8") as file:
+        try:
+            output = loads(file.read())
+        except JSONDecodeError:
+            logWrite(
+                f"Could not load json file {filepath}: file seems to be incorrect!\n{print_exc()}"
+            )
+            raise
+        except FileNotFoundError:
+            logWrite(
+                f"Could not load json file {filepath}: file does not seem to exist!\n{print_exc()}"
+            )
+            raise
+        file.close()
+    return output
+
+
+def jsonSave(contents: Union[list, dict], filepath: str) -> None:
+    """Save contents into json file
+
+    ### Args:
+        * contents (`Union[list, dict]`): Some json serializable
+        * filepath (`str`): Path to output file
+    """
+    try:
+        with open(filepath, "w", encoding="utf8") as file:
+            file.write(dumps(contents, ensure_ascii=False, indent=4))
+            file.close()
+    except Exception as exp:
+        logWrite(f"Could not save json file {filepath}: {exp}\n{print_exc()}")
+    return
+
+
+def configGet(key: str, *args: str) -> Any:
+    """Get value of the config key
+
+    ### Args:
+        * key (`str`): The last key of the keys path.
+        * *args (`str`): Path to key like: dict[args][key].
+
+    ### Returns:
+        * `Any`: Value of provided key
+    """
+    this_dict = jsonLoad("config.json")
+    this_key = this_dict
+    for dict_key in args:
+        this_key = this_key[dict_key]
+    return this_key[key]
+
+
+def apiKeyInvalid(obj):
+    obj.send_response(401)
+    obj.send_header("Content-type", "application/json; charset=utf-8")
+    obj.end_headers()
+    obj.wfile.write(b'{"code":401, "message": "Invalid API key"}')
+    return
+
+
+def apiKeyExpired(obj):
+    obj.send_response(403)
+    obj.send_header("Content-type", "application/json; charset=utf-8")
+    obj.end_headers()
+    obj.wfile.write(b'{"code":403, "message": "API key expired"}')
+    return

pages/home/index.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html lang="en" >
+<head>
+  <meta charset="UTF-8">
+  <title>END PLAY Photos API • Home</title>
+  <link href="/pages/matter.css" rel="stylesheet">
+  <link rel="stylesheet" href="/pages/home/style.css">
+</head>
+
+<body>
+
+  <form class="registration">
+
+    <h1>👋 Welcome!</h1>
+
+    <p>You need to register in order to use this API.</p>
+    <p>After registering use official docs to learn how to authentiticate and start managing photos.</p>
+
+    <center><a class="matter-button-contained" href="https://photos.end-play.xyz/register">Sign Up</a></center>
+
+  </form>
+
+</body>
+</html>

pages/home/script.js

@@ -0,0 +1,6 @@
+// JavaScript is used for toggling loading state
+var form = document.querySelector('form');
+form.onsubmit = function (event) {
+    event.preventDefault();
+    form.classList.add('signed');
+};

pages/home/style.css

@@ -0,0 +1,105 @@
+@import url('https://fonts.cdnfonts.com/css/google-sans');
+
+/* Material Customization */
+:root {
+    --pure-material-primary-rgb: 255, 191, 0;
+    --pure-material-onsurface-rgb: 0, 0, 0;
+}
+
+body {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    min-height: 100vh;
+    background: url("https://res.cloudinary.com/finnhvman/image/upload/v1541930411/pattern.png");
+}
+
+.registration {
+    position: relative;
+    border-radius: 8px;
+    padding: 16px 48px 30px 30px;
+    box-shadow: 0 3px 1px -2px rgba(0, 0, 0, 0.2), 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12);
+    overflow: hidden;
+    background-color: white;
+}
+
+.registration h1 {
+    margin: 32px 0;
+    font-family: 'Product Sans', sans-serif;
+    font-weight: normal;
+    text-align: center;
+}
+
+.registration > label {
+    display: block;
+    margin: 24px 0;
+    width: 320px;
+}
+
+p {
+    font-family: 'Product Sans', sans-serif;
+    font-weight: normal;
+    text-align: center;
+    color: #2b2b2b;
+}
+
+a.matter-button-contained {
+    font-family: 'Product Sans', sans-serif;
+    text-decoration: none;
+}
+
+a {
+    color: rgb(var(--pure-material-primary-rgb));
+    font-family: 'Product Sans', sans-serif;
+    text-decoration: none;
+}
+
+a:hover {
+    text-decoration: none;
+}
+
+.matter-button-contained {
+    margin-top: 10px;
+}
+
+@media only screen and (max-width: 980px) {
+
+    .registration {
+        position: fixed;
+        border-radius: none;
+        padding: auto;
+        box-shadow: none;
+        overflow: visible;
+    }
+
+    .registration {
+        width: 95%;
+        height: auto;
+    }
+
+    .registration h1 {
+        font-size: 64px;
+    }
+
+    body {
+        background: none;
+        min-height: 85vh;
+    }
+
+    p {
+        font-size: 42px;
+    }
+
+    .matter-button-contained {
+        padding-top: 0.5em;
+        padding-bottom: 1.3em;
+        padding-left: 0.65em;
+        padding-right: 0.65em;
+        border-radius: 7px;
+    }
+
+    a.matter-button-contained {
+        font-size: 3.2em;
+    }
+
+}

pages/register/index.html

@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html lang="en" >
+<head>
+  <meta charset="UTF-8">
+  <title>END PLAY Photos API • Sign Up</title>
+  <link href="/pages/matter.css" rel="stylesheet">
+  <link rel="stylesheet" href="/pages/register/style.css">
+</head>
+
+<body>
+<!-- partial:index.partial.html -->
+<iframe name="hiddenFrame" width="0" height="0" border="0" style="display: none;"></iframe>
+
+<form class="registration" method="post" action="/users" enctype="application/x-www-form-urlencoded" target="hiddenFrame">
+  <h1>👋 Welcome!</h1>
+
+  <label class="matter-textfield-outlined">
+     <input placeholder=" " type="text" alt="You won't be able to change it later!" id="user" name="user" required>
+      <span>Username</span>
+  </label>
+
+  <label class="matter-textfield-outlined">
+     <input placeholder=" " type="email" id="email" name="email" required>
+      <span>Email</span>
+  </label>
+
+  <label class="matter-textfield-outlined">
+    <input placeholder=" " type="password" id="password" name="password" required>
+    <span>Password</span>
+  </label>
+
+  <label class="matter-checkbox">
+    <input type="checkbox" required>
+    <span>I agree to the <a href="https://codepen.io/collection/nZKBZe/" target="_blank" title="Actually not a Terms of Service">Terms of Service</a></span>
+  </label>
+
+  <center><a class="matter-button-contained" href="https://photos.end-play.xyz/register" type="submit" value="Submit">Sign Up</a></center>
+  <!-- <button class="matter-button-contained" type="submit" value="Submit">Sign Up</button> -->
+
+  <div class="done">
+    <h1>👌 You're all set!</h1>
+    <p>You should now receive an email with activation link.</p>
+    <p>Activate your account and proceed to docs if you'd like to learn how to use API now.</p>
+    <a class="matter-button-text" href="/docs">Docs</a>
+  </div>
+  <div class="progress">
+    <progress class="matter-progress-circular" />
+  </div>
+</form>
+
+<!-- partial -->
+  <script  src="/pages/register/script.js"></script>
+
+</body>
+</html>

pages/register/script.js

@@ -0,0 +1,7 @@
+// JavaScript is used for toggling loading state
+var form = document.querySelector('form');
+form.onsubmit = function (event) {
+    event.preventDefault();
+    form.classList.add('signed');
+    form.submit();
+};

pages/register/style.css

@@ -0,0 +1,192 @@
+/* Material Customization */
+:root {
+    --pure-material-primary-rgb: 255, 191, 0;
+    --pure-material-onsurface-rgb: 0, 0, 0;
+}
+
+body {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    min-height: 100vh;
+    background: url("https://res.cloudinary.com/finnhvman/image/upload/v1541930411/pattern.png");
+}
+
+.registration {
+    position: relative;
+    border-radius: 8px;
+    padding: 16px 48px;
+    box-shadow: 0 3px 1px -2px rgba(0, 0, 0, 0.2), 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12);
+    overflow: hidden;
+    background-color: white;
+}
+
+h1 {
+    margin: 32px 0;
+    font-family: "Roboto", "Segoe UI", BlinkMacSystemFont, system-ui, -apple-system;
+    font-weight: normal;
+    text-align: center;
+}
+
+.registration > label {
+    display: block;
+    margin: 24px 0;
+    width: 320px;
+}
+
+a {
+    color: rgb(var(--pure-material-primary-rgb));
+    text-decoration: none;
+}
+
+a:hover {
+    text-decoration: underline;
+}
+
+button {
+    display: block !important;
+    margin: 32px auto;
+}
+
+.done,
+.progress {
+    position: absolute;
+    top: 0;
+    bottom: 0;
+    left: 0;
+    right: 0;
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    justify-content: center;
+    background-color: white;
+    visibility: hidden;
+    padding-left: 40px;
+    padding-right: 40px;
+    text-align: center;
+}
+
+.done {
+    transition: visibility 0s 1s;
+}
+
+.signed > .done {
+    visibility: visible;
+}
+
+.done > a {
+    display: inline-block;
+    text-decoration: none;
+}
+
+.progress {
+    opacity: 0;
+}
+
+.signed > .progress {
+    animation: loading 3s;
+}
+
+@keyframes loading {
+    0% {
+        visibility: visible;
+    }
+    12.5% {
+        opacity: 0;
+    }
+    25% {
+        opacity: 1;
+    }
+    87.5% {
+        opacity: 1;
+    }
+    100% {
+        opacity: 0;
+    }
+}
+
+.left-footer,
+.right-footer {
+    position: fixed;
+    padding: 14px;
+    bottom: 14px;
+    color: #555;
+    background-color: #eee;
+    font-family: "Roboto", "Segoe UI", BlinkMacSystemFont, system-ui, -apple-system;
+    font-size: 14px;
+    line-height: 1.5;
+    box-shadow: 0 3px 1px -2px rgba(0, 0, 0, 0.2), 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12);
+}
+
+.left-footer {
+    left: 0;
+    border-radius: 0 4px 4px 0;
+    text-align: left;
+}
+
+.right-footer {
+    right: 0;
+    border-radius: 4px 0 0 4px;
+    text-align: right;
+}
+
+.left-footer > a,
+.right-footer > a {
+    color: black;
+}
+
+.left-footer > a:hover,
+.right-footer > a:hover {
+    text-decoration: underline;
+}
+
+@media only screen and (max-width: 980px) {
+
+    .registration {
+        width: 90%;
+        height: auto;
+        position: fixed;
+        border-radius: none;
+        padding: auto;
+        box-shadow: none;
+        overflow: visible;
+    }
+
+    body {
+        background: none;
+        min-height: 85vh;
+    }
+
+    p {
+        font-size: 36px;
+    }
+
+    .registration h1 {
+        font-size: 64px;
+    }
+    
+    .matter-button-contained {
+        padding-top: 0.5em;
+        padding-bottom: 1.3em;
+        padding-left: 0.65em;
+        padding-right: 0.65em;
+        border-radius: 7px;
+    }
+    
+    .matter-button-text {
+        padding-top: 0.4em;
+        padding-bottom: 1.3em;
+        padding-left: 0.65em;
+        padding-right: 0.65em;
+        border-radius: 7px;
+    }
+
+    a.matter-button-contained {
+        font-size: 3.2em;
+    }
+
+    a.matter-button-text {
+        font-size: 2.6em;
+    }
+
+}

photos_api.py

@@ -0,0 +1,22 @@
+from os import makedirs, path
+
+from fastapi.responses import FileResponse
+
+from modules.app import app
+from modules.extensions_loader import dynamic_import_from_src
+from modules.scheduler import scheduler
+from modules.utils import *
+
+makedirs(path.join("data", "users"), exist_ok=True)
+
+
+@app.get("/favicon.ico", response_class=FileResponse, include_in_schema=False)
+async def favicon():
+    return FileResponse("favicon.ico")
+
+
+# =================================================================================
+dynamic_import_from_src("extensions", star_import=True)
+# =================================================================================
+
+scheduler.start()

requirements.txt

@@ -0,0 +1,11 @@
+aiofiles==23.1.0
+apscheduler~=3.10.1
+exif==1.6.0
+fastapi[all]==0.97.0
+opencv-python~=4.7.0.72
+passlib~=1.7.4
+pymongo==4.4.0
+python-jose[cryptography]~=3.3.0
+python-magic~=0.4.27
+scipy~=1.10.1
+ujson~=5.8.0