Compare commits
5 Commits
Author | SHA1 | Date | |
---|---|---|---|
80569850c4 | |||
2b606f9010 | |||
ede365af7d | |||
45a6522e2f | |||
88f05c5529 |
10
CHANGELOG.md
Normal file
10
CHANGELOG.md
Normal file
@ -0,0 +1,10 @@
|
||||
# Changelog
|
||||
|
||||
## v0.1.0
|
||||
|
||||
### Added or Changed
|
||||
- Create the directories structure for the nim-lib library.
|
||||
|
||||
### Removed
|
||||
|
||||
- Nothing
|
674
LICENSE.txt
Normal file
674
LICENSE.txt
Normal file
@ -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>.
|
305
README.md
305
README.md
@ -0,0 +1,305 @@
|
||||
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
|
||||
<a name="readme-top"></a>
|
||||
<!--
|
||||
*** Thanks for checking out the Best-README-Template. If you have a suggestion
|
||||
*** that would make this better, please fork the repo and create a pull request
|
||||
*** or simply open an issue with the tag "enhancement".
|
||||
*** Don't forget to give the project a star!
|
||||
*** Thanks again! Now go create something AMAZING! :D
|
||||
-->
|
||||
|
||||
|
||||
|
||||
<!-- PROJECT SHIELDS -->
|
||||
<!--
|
||||
*** I'm using markdown "reference style" links for readability.
|
||||
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
||||
*** See the bottom of this document for the declaration of the reference variables
|
||||
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
||||
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
||||
-->
|
||||
[![GNU License][license-shield]][license-url]
|
||||
[![Nim][Nim.com]][Nim-url]
|
||||
[![LinkedIn][linkedin-shield]][linkedin-url]
|
||||
|
||||
|
||||
|
||||
<!-- PROJECT LOGO -->
|
||||
<br />
|
||||
<div align="center">
|
||||
<a href="https://git.bcmaison.cf/Projets/nim-lib">
|
||||
<img src="images/logo-nim.jpg" alt="Logo" width="250" height="100">
|
||||
</a>
|
||||
|
||||
<h3 align="center">Nim Lib</h3>
|
||||
|
||||
<p align="center">
|
||||
Personal Nim library
|
||||
<br />
|
||||
<a href="https://git.bcmaison.cf/Projets/nim-lib"><strong>Explore the docs »</strong></a>
|
||||
<br />
|
||||
<br />
|
||||
<a href="#">View Demo</a>
|
||||
·
|
||||
<a href="https://git.bcmaison.cf/Projets/nim-lib/issues">Report Bug</a>
|
||||
·
|
||||
<a href="https://git.bcmaison.cf/Projets/nim-lib/pulls">Request Feature</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<!-- TABLE OF CONTENTS -->
|
||||
<details>
|
||||
<summary>Table of Contents</summary>
|
||||
<ol>
|
||||
<li>
|
||||
<a href="#about-the-project">About The Project</a>
|
||||
<ul>
|
||||
<li><a href="#built-with">Built With</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#getting-started">Getting Started</a>
|
||||
<ul>
|
||||
<li><a href="#prerequisites">Prerequisites</a></li>
|
||||
<li><a href="#installation">Installation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#usage">Usage</a></li>
|
||||
<li><a href="#base">Base</a></li>
|
||||
<li><a href="#usage">Usage</a></li>
|
||||
<li><a href="#usage">Usage</a></li>
|
||||
<li><a href="#usage">Usage</a></li>
|
||||
<li><a href="#usage">Usage</a></li>
|
||||
<li><a href="#roadmap">Roadmap</a></li>
|
||||
<li><a href="#contributing">Contributing</a></li>
|
||||
<li><a href="#license">License</a></li>
|
||||
<li><a href="#contact">Contact</a></li>
|
||||
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
||||
</ol>
|
||||
</details>
|
||||
|
||||
<!-- ABOUT THE PROJECT -->
|
||||
## About The Project
|
||||
|
||||
[![Product Name Screen Shot][product-screenshot]](https://git.bcmaison.cf/Projets/nim-lib/src/branch/main/images/screenshot.png)
|
||||
|
||||
Cette librairie permet de centraliser tous les types de besoins génériques à une même place. Elle est découpé en plusieurs regroupement :
|
||||
|
||||
|
||||
| Section | script | description |
|
||||
| -------------------- | ----------------------- | ---------------------------------------------------------------------------- |
|
||||
| 📂 base | 📄 OutilsBase.nim | Fonctions de base, petit traitement et opérations sur chaines, encryption. |
|
||||
| 📂 commun | 📄 OutilsCommun.nim | Traitement et fonctions communes sur heures, date, os, fichiers, répertoires |
|
||||
| 📂 commun | 📄 password_utils.nim | |
|
||||
| 📂 commun | 📄 utils.nim | |
|
||||
| 📂 commun ➡️ load | 📄 | Fonctions de chargement des données de divers types (CSV, list, json, ...) |
|
||||
| 📂 commun ➡️ save | 📄 | Fonctions de sauvegarde des données de divers types (CSV, list, json, ...) |
|
||||
| 📂 Communication | 📄 | Fonctions de communications |
|
||||
| 📂 Comm. ➡️ discord | 📄 | communication de type discord |
|
||||
| 📂 Comm. ➡️ email | 📄 | communication de type email |
|
||||
| 📂 Comm. ➡️ server | 📄 | communication de type serveur |
|
||||
| 📂 Comm. ➡️ Joplin | 📄 joplin_json_utils.nim | communication de type Joplin |
|
||||
| 📂 Comm. ➡️ Joplin | 📄 joplin_utils.nim | communication de type Joplin |
|
||||
| 📂 db | 📄 database_utils.nim | Fonctions de type base de données |
|
||||
| 📂 listes | 📄 | Fonctions de traitement de listes |
|
||||
| 📂 windows ➡️ registry | 📄 | (Windows) Fonctions de traitement sur clé de registre |
|
||||
| 📂 windows ➡️ wmi | 📄 | (Windows) Fonctions de traitement sur WMI |
|
||||
| 📂 web | 📄 web_utils.nim | Fonctions de type web |
|
||||
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
### Built With
|
||||
|
||||
Ces fonctions sont fait pour des projets développés en Nim. Voici la liste des modules a importer par script.
|
||||
|
||||
| Section | script | modules |
|
||||
| -------------------- | ----------------------- | -------------------------------- |
|
||||
| 📂 base | 📄 OutilsBase.nim | |
|
||||
| 📂 commun | 📄 OutilsCommun.nim | |
|
||||
| 📂 commun | 📄 password_utils.nim | md5, bcrypt, random |
|
||||
| 📂 commun | 📄 utils.nim | std/times |
|
||||
| 📂 commun ➡️ load | | |
|
||||
| 📂 commun ➡️ save | | |
|
||||
| 📂 Communication | | |
|
||||
| 📂 Comm. ➡️ discord | | |
|
||||
| 📂 Comm. ➡️ email | | |
|
||||
| 📂 Comm. ➡️ server | | |
|
||||
| 📂 Comm. ➡️ Joplin | 📄 joplin_json_utils.nim | |
|
||||
| 📂 Comm. ➡️ Joplin | 📄 joplin_utils.nim | |
|
||||
| 📂 db | 📄 database_utils.nim | os, logging, parsecfg, db_sqlite |
|
||||
| 📂 listes | 📄 listes_utils.nim | |
|
||||
| 📂 windows ➡️ registry | 📄 registry_utils.nim | |
|
||||
| 📂 windows ➡️ wmi | 📄 wmi_utils.nim | |
|
||||
| 📂 web | 📄 web_utils.nim | |
|
||||
|
||||
|
||||
[![Nim][Nim.com]][Nim-url]
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
|
||||
|
||||
<!-- GETTING STARTED -->
|
||||
## Getting Started
|
||||
|
||||
This is an example of how you may give instructions on setting up your project locally.
|
||||
To get a local copy up and running follow these simple example steps.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
This is an example of how to list things you need to use the software and how to install them.
|
||||
* npm
|
||||
```sh
|
||||
npm install npm@latest -g
|
||||
```
|
||||
|
||||
### Installation
|
||||
|
||||
_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
|
||||
|
||||
1. Get a free API Key at [https://example.com](https://example.com)
|
||||
2. Clone the repo
|
||||
```sh
|
||||
git clone https://github.com/your_username_/Project-Name.git
|
||||
```
|
||||
3. Install NPM packages
|
||||
```sh
|
||||
npm install
|
||||
```
|
||||
4. Enter your API in `config.js`
|
||||
```js
|
||||
const API_KEY = 'ENTER YOUR API';
|
||||
```
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
|
||||
|
||||
<!-- USAGE EXAMPLES -->
|
||||
## Usage
|
||||
|
||||
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
|
||||
|
||||
_For more examples, please refer to the [Documentation](https://example.com)_
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
<!-- SECTION BASE -->
|
||||
## Base
|
||||
|
||||
Détails, spécifications spécial sur la section Base
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
|
||||
<!-- ROADMAP -->
|
||||
## Roadmap
|
||||
|
||||
- [x] Add Changelog
|
||||
- [x] Add back to top links
|
||||
- [ ] Add Additional Templates w/ Examples
|
||||
- [ ] Add "components" document to easily copy & paste sections of the readme
|
||||
- [ ] Multi-language Support
|
||||
- [ ] Chinese
|
||||
- [ ] Spanish
|
||||
|
||||
See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
|
||||
|
||||
<!-- CONTRIBUTING -->
|
||||
## Contributing
|
||||
|
||||
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
||||
|
||||
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
|
||||
Don't forget to give the project a star! Thanks again!
|
||||
|
||||
1. Fork the Project
|
||||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
||||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
|
||||
|
||||
<!-- LICENSE -->
|
||||
## License
|
||||
|
||||
Distributed under the GNU Public License. See `LICENSE.txt` for more information.
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
|
||||
|
||||
<!-- CONTACT -->
|
||||
## Contact
|
||||
|
||||
Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com
|
||||
|
||||
Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
|
||||
|
||||
<!-- ACKNOWLEDGMENTS -->
|
||||
## Acknowledgments
|
||||
|
||||
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
|
||||
|
||||
* [Choose an Open Source License](https://choosealicense.com)
|
||||
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
|
||||
* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
|
||||
* [Malven's Grid Cheatsheet](https://grid.malven.co/)
|
||||
* [Img Shields](https://shields.io)
|
||||
* [GitHub Pages](https://pages.github.com)
|
||||
* [Font Awesome](https://fontawesome.com)
|
||||
* [React Icons](https://react-icons.github.io/react-icons/search)
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
|
||||
|
||||
<!-- MARKDOWN LINKS & IMAGES -->
|
||||
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
||||
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
|
||||
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
|
||||
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
|
||||
[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
|
||||
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
|
||||
[stars-url]: https://git.bcmaison.cf/Projets/nim-lib/stars
|
||||
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
|
||||
[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
|
||||
[license-shield]: https://img.shields.io/badge/LICENSE-GNU-green?style=for-the-badge
|
||||
[license-url]: https://git.bcmaison.cf/Projets/nim-lib/src/branch/main/LICENSE.txt
|
||||
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
|
||||
[linkedin-url]: https://www.linkedin.com/in/bruno-charest-a3a6158/
|
||||
[product-screenshot]: images/screenshot.png
|
||||
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
|
||||
[Next-url]: https://nextjs.org/
|
||||
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
|
||||
[React-url]: https://reactjs.org/
|
||||
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
|
||||
[Vue-url]: https://vuejs.org/
|
||||
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
|
||||
[Angular-url]: https://angular.io/
|
||||
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
|
||||
[Svelte-url]: https://svelte.dev/
|
||||
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
|
||||
[Laravel-url]: https://laravel.com
|
||||
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
|
||||
[Bootstrap-url]: https://getbootstrap.com
|
||||
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
|
||||
[JQuery-url]: https://jquery.com
|
||||
[Nim.com]: https://img.shields.io/badge/Nim-000000?style=for-the-badge&logo=Nim&logoColor=Yellow
|
||||
[Nim-url]: https://nim-lang.org/
|
||||
|
||||
https://img.shields.io/git.bcmaison.cf/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
|
BIN
images/logo-nim.jpg
Normal file
BIN
images/logo-nim.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 7.3 KiB |
BIN
images/logo.png
Normal file
BIN
images/logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.3 KiB |
BIN
images/screenshot.png
Normal file
BIN
images/screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 25 KiB |
0
outils/base/OutilsBase.nim
Normal file
0
outils/base/OutilsBase.nim
Normal file
0
outils/commun/OutilsCommun.nim
Normal file
0
outils/commun/OutilsCommun.nim
Normal file
56
outils/commun/password_utils.nim
Normal file
56
outils/commun/password_utils.nim
Normal file
@ -0,0 +1,56 @@
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
# Bruno Charest
|
||||
# 2022-08-09
|
||||
#
|
||||
# __ DESCRIPTIONS __
|
||||
# password_utils : procedure related password
|
||||
#
|
||||
# Inspiration of : https://ttj.dk/blog/2019/01/20/setup-a-website-with-nim
|
||||
# Copyright 2019 - Thomas T. Jarløv
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
import md5
|
||||
import bcrypt
|
||||
import random
|
||||
randomize()
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# Let and VAR : for random
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
var urandom: File
|
||||
let useUrandom = urandom.open("/dev/urandom")
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==--=--==--==--=--==--==--=--==--==-- #
|
||||
# PROC : Make Salt
|
||||
## : Generate random salt. Uses cryptographically secure /dev/urandom
|
||||
## : on platforms where it is available, and Nim's random module in other cases.
|
||||
# --==--==--==--==--==--==--==--==--==--==--=--==--==--=--==--==--=--==--==-- #
|
||||
proc makeSalt*(): string =
|
||||
result = ""
|
||||
if useUrandom:
|
||||
var randomBytes: array[0..127, char]
|
||||
discard urandom.readBuffer(addr(randomBytes), 128)
|
||||
for ch in randomBytes:
|
||||
if ord(ch) in {32..126}:
|
||||
result.add(ch)
|
||||
else:
|
||||
for i in 0..127:
|
||||
result.add(chr(rand(94) + 32)) # Generate numbers from 32 to 94 + 32 = 126
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : Make session key
|
||||
## Creates a random key to be used to authorize a session.
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc makeSessionKey*(): string =
|
||||
let random = makeSalt()
|
||||
return bcrypt.hash(random, genSalt(8))
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : make password
|
||||
## Creates an MD5 hash by combining password and salt
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc makePassword*(password, salt: string, comparingTo = ""): string =
|
||||
let bcryptSalt = if comparingTo != "": comparingTo else: genSalt(8)
|
||||
result = hash(getMD5(salt & getMD5(password)), bcryptSalt)
|
22
outils/commun/utils.nim
Normal file
22
outils/commun/utils.nim
Normal file
@ -0,0 +1,22 @@
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
# Bruno Charest
|
||||
# 2022-10-25
|
||||
#
|
||||
# __ DESCRIPTIONS __
|
||||
# utils : procedures generals utils
|
||||
#
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
|
||||
import std/times
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : Convert epoch millisecond time to human readable time
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc convertEpochToHumanTime*(epochTime: int): string =
|
||||
var humanTime: Time
|
||||
var dateTime: string
|
||||
humanTime = fromUnix(convert(Milliseconds, Seconds, epochTime))
|
||||
dateTime = format(humanTime, "yyyy-MM-dd' 'HH:mm")
|
||||
# echo dateTime
|
||||
return dateTime
|
||||
|
24
outils/communication/joplin/joplin_json_utils.nim
Normal file
24
outils/communication/joplin/joplin_json_utils.nim
Normal file
@ -0,0 +1,24 @@
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
# Bruno Charest
|
||||
# 2022-08-09
|
||||
#
|
||||
# __ DESCRIPTIONS __
|
||||
# joplin_json_utils : Types and procedure related to json request
|
||||
#
|
||||
# [TODO] joplin_json_utils : need to create many procedures
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# TYPE : Data structure for TAGS
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type Tag = object
|
||||
id : string
|
||||
parent_id : string
|
||||
title: string
|
||||
|
||||
type Tags = object
|
||||
items: seq[Tag]
|
||||
has_more: string
|
||||
|
||||
|
||||
|
519
outils/communication/joplin/joplin_utils.nim
Normal file
519
outils/communication/joplin/joplin_utils.nim
Normal file
@ -0,0 +1,519 @@
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
# Bruno Charest
|
||||
# 2022-08-09
|
||||
#
|
||||
# __ DESCRIPTIONS __
|
||||
# joplin_utils : procedure related joplin application
|
||||
#
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
import os
|
||||
import net
|
||||
import times
|
||||
import osproc
|
||||
import jester
|
||||
import std/json
|
||||
import httpcore
|
||||
import strutils
|
||||
import strformat
|
||||
import std/options
|
||||
import std/httpclient
|
||||
import std/asyncdispatch
|
||||
|
||||
import ../../commun/utils # Joplin utils procedures and types
|
||||
|
||||
# from os import sleep
|
||||
# from posix import read, write, fdatasync, close
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# TYPE : Setup joplin_ping data
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type
|
||||
joplin_ping* = object
|
||||
ping_result*: seq[string]
|
||||
ping_status*: bool
|
||||
req*: Request
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# TYPE : Setup joplin_tags data
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type
|
||||
joplin_tags* = object
|
||||
id*, parent_id*, title*: seq[string]
|
||||
created_time*, updated_time*, user_created_time*, user_updated_time*,
|
||||
is_shared*: seq[int]
|
||||
req*: Request
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# TYPE : Setup joplin_notebooks data
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type
|
||||
joplin_notebooks* = object
|
||||
id*, parent_id*, title*, share_id*, icon*: seq[string]
|
||||
created_time*, updated_time*, user_created_time*, user_updated_time*,
|
||||
is_shared*: seq[int]
|
||||
req*: Request
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# TYPE : Setup joplin_notes data
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type
|
||||
joplin_notes* = object
|
||||
id*, parent_id*, title*, body*, author*, source_url*, source*,
|
||||
source_application*, application_data*, share_id*,
|
||||
conflict_original_id*, body_html*, base_url*: seq[string]
|
||||
updated_time*, is_conflict*, is_todo*, todo_due*,
|
||||
todo_completed*, user_created_time*, user_updated_time*,
|
||||
markup_language*, is_shared*: seq[int]
|
||||
latitude*, longitude*, altitude*, order*: seq[float]
|
||||
created_time*: seq[string]
|
||||
req*: Request
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# TYPE : Setup joplin_note data
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type
|
||||
joplin_note* = object
|
||||
id*, parent_id*, title*, body*, author*, source_url*, source*,
|
||||
source_application*, application_data*, conflict_original_id*,
|
||||
master_key_id*, share_id*, encryption_cipher_text * : string
|
||||
created_time*, updated_time*, user_created_time*, user_updated_time*,
|
||||
is_conflict*, is_todo*, todo_due*, todo_completed*, markup_language*,
|
||||
is_shared*, encryption_applied*: int
|
||||
latitude*, longitude*, altitude*, order*: float
|
||||
req*: Request
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# TYPE : Setup process data structure
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type
|
||||
program* = object
|
||||
pid*: int
|
||||
stdout*: string
|
||||
stderr*: string
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# DURATION : duration variables
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
let
|
||||
resetDuration = initDuration(seconds = 2)
|
||||
deciSecondDuration* = initDuration(milliseconds = 100)
|
||||
qtrsecondDuration* = initDuration(milliseconds = 250)
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# VAR : connexion http variables
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
var
|
||||
client = newHttpClient()
|
||||
lastConnection = getTime().utc
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : reset HTTP client
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc resetHttpClient() =
|
||||
if (getTime().utc - lastConnection) > resetDuration:
|
||||
# Probably a new timeout. We have not yet experienced a long outage.
|
||||
# We may however be entering an extended outage.
|
||||
# Creating the new clients seems to use up lots of CPU.
|
||||
# I want to do that as little as possible.
|
||||
try:
|
||||
client.close()
|
||||
except:
|
||||
echo("Attempted to close clients. Probably do not exist.")
|
||||
echo("Current exception: ", getCurrentExceptionMsg())
|
||||
client = newHttpClient(timeout = 500)
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==-==--==--==- #
|
||||
# PROC : use the joplin API ping to validate service availibility
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==-==--==--==- #
|
||||
proc ping_joplin*(token: string): Future[joplin_ping] {.async.} =
|
||||
|
||||
var j_p: joplin_ping
|
||||
var client = newAsyncHttpClient()
|
||||
var url: string
|
||||
j_p.ping_status = false
|
||||
try:
|
||||
url = fmt"http://localhost:41184/ping?token={token}"
|
||||
var json = await client.getContent(url)
|
||||
j_p.ping_result.add(json)
|
||||
|
||||
echo j_p.ping_result[0]
|
||||
|
||||
if j_p.ping_result[0] == "JoplinClipperServer":
|
||||
j_p.ping_status = true
|
||||
|
||||
except TimeoutError, IOError, OSError:
|
||||
# I naively think I would see this thrown or the plain except below.
|
||||
# But I almost never see an Error raised.
|
||||
echo("Current Exception: ", getCurrentException().name)
|
||||
echo("Current Exception Msg: ", getCurrentExceptionMsg())
|
||||
echo("Sleeping for 1 seconds at: ", getTime().utc)
|
||||
sleep(500)
|
||||
resetHttpClient()
|
||||
j_p.ping_status = false
|
||||
except:
|
||||
echo("Current Exception: ", getCurrentException().name)
|
||||
echo("Current Exception Msg: ", getCurrentExceptionMsg())
|
||||
echo("Sleeping for 1 seconds at: ", getTime().utc)
|
||||
j_p.ping_status = false
|
||||
return j_p
|
||||
# parse jason
|
||||
#let joplin_notes_Json = parseJson(json)
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : get all joplin NOTEBOOKS
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc get_joplin_notebooks*(token: string): Future[joplin_notebooks] {.async.} =
|
||||
|
||||
# Variables
|
||||
var j_nb: joplin_notebooks
|
||||
var has_more: bool = true
|
||||
var page: int = 1
|
||||
var url: string
|
||||
var client = newAsyncHttpClient()
|
||||
var pingCheck: joplin_ping
|
||||
|
||||
pingCheck = waitFor ping_joplin(token)
|
||||
|
||||
# check the joplin status befor query
|
||||
if pingCheck.ping_status:
|
||||
|
||||
# make sure to check all pages
|
||||
while has_more == true:
|
||||
|
||||
# request joplin API for notebooks
|
||||
url = fmt"http://localhost:41184/folders?page={page}&token={token}"
|
||||
echo("URL notebooks : ", url)
|
||||
var json = await client.getContent(url)
|
||||
|
||||
# parse jason
|
||||
let joplin_notebooks_Json = parseJson(json)
|
||||
|
||||
# valider qu'il n'y a plus de page
|
||||
if not joplin_notebooks_Json["has_more"].getBool:
|
||||
has_more = false
|
||||
|
||||
# store json info into an object
|
||||
var count: int = 1
|
||||
for nb in joplin_notebooks_Json["items"]:
|
||||
j_nb.id.add(nb["id"].getstr)
|
||||
j_nb.parent_id.add(nb["parent_id"].getstr)
|
||||
j_nb.title.add(nb["title"].getstr)
|
||||
count += 1
|
||||
|
||||
# aller à la page suivante
|
||||
page += 1
|
||||
|
||||
return j_nb
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : get all joplin NOTES
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc get_joplin_notes*(token: string): Future[joplin_notes] {.async.} =
|
||||
|
||||
# Variables
|
||||
var j_notes: joplin_notes
|
||||
var has_more: bool = true
|
||||
var page: int = 1
|
||||
var url: string
|
||||
var client = newAsyncHttpClient()
|
||||
var pingCheck: joplin_ping
|
||||
pingCheck = waitFor ping_joplin(token)
|
||||
|
||||
# check the joplin status befor query
|
||||
if pingCheck.ping_status:
|
||||
|
||||
# make sure to check all pages
|
||||
while has_more == true:
|
||||
|
||||
# request joplin API for Notes
|
||||
url = fmt"http://localhost:41184/notes?page={page}&fields=id,parent_id,title,created_time,updated_time&token={token}"
|
||||
echo("URL notes : ", url)
|
||||
var json = await client.getContent(url)
|
||||
|
||||
# parse jason
|
||||
let joplin_notes_Json = parseJson(json)
|
||||
|
||||
# valider qu'il n'y a plus de page
|
||||
if not joplin_notes_Json["has_more"].getBool:
|
||||
has_more = false
|
||||
|
||||
#echo joplin_notes_Json
|
||||
|
||||
# store json info into an object
|
||||
var count: int = 1
|
||||
# var epochTime: int
|
||||
# var humanTime: Time
|
||||
for nb in joplin_notes_Json["items"]:
|
||||
j_notes.id.add(nb["id"].getstr)
|
||||
j_notes.parent_id.add(nb["parent_id"].getstr)
|
||||
j_notes.title.add(nb["title"].getstr)
|
||||
#epochTime = nb["created_time"].getInt
|
||||
#humanTime = fromUnix(convert(Milliseconds, Seconds, epochTime))
|
||||
|
||||
j_notes.created_time.add(convertEpochToHumanTime(nb[
|
||||
"created_time"].getInt))
|
||||
count += 1
|
||||
|
||||
# aller à la page suivante
|
||||
page += 1
|
||||
|
||||
return j_notes
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : get joplin NOTE
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc get_joplin_note*(token: string, noteid: string): Future[
|
||||
joplin_note] {.async.} =
|
||||
|
||||
# Variables
|
||||
var j_note: joplin_note
|
||||
# var has_more: bool = true
|
||||
# var page: int = 1
|
||||
var url: string
|
||||
var client = newAsyncHttpClient()
|
||||
|
||||
# Check joplin connection availibility
|
||||
var pingCheck: joplin_ping
|
||||
pingCheck = waitFor ping_joplin(token)
|
||||
|
||||
|
||||
# Query for a selected note
|
||||
url = fmt"http://localhost:41184/notes/{noteid}?fields=id,parent_id,title,body,created_time,updated_time,is_conflict,latitude,longitude,altitude,author,source_url,is_todo,todo_due,todo_completed,source,source_application,application_data,order,user_created_time,user_updated_time,encryption_cipher_text,encryption_applied,markup_language,is_shared,share_id,conflict_original_id,master_key_id&token={token}"
|
||||
echo("URL notes : ", url)
|
||||
var jsonNote = await client.getContent(url)
|
||||
|
||||
# parse jason
|
||||
let joplin_note_Json = parseJson(jsonNote)
|
||||
|
||||
# get all informations for a selected note
|
||||
j_note.id = joplin_note_Json["id"].getstr
|
||||
j_note.parent_id = joplin_note_Json["parent_id"].getstr
|
||||
j_note.title = joplin_note_Json["title"].getstr
|
||||
j_note.body = joplin_note_Json["body"].getstr
|
||||
j_note.author = joplin_note_Json["author"].getstr
|
||||
j_note.source_url = joplin_note_Json["source_url"].getstr
|
||||
j_note.source = joplin_note_Json["source"].getstr
|
||||
j_note.source_application = joplin_note_Json["source_application"].getstr
|
||||
j_note.application_data = joplin_note_Json["application_data"].getstr
|
||||
j_note.share_id = joplin_note_Json["share_id"].getstr
|
||||
j_note.conflict_original_id = joplin_note_Json["conflict_original_id"].getstr
|
||||
j_note.created_time = joplin_note_Json["created_time"].getInt
|
||||
j_note.updated_time = joplin_note_Json["updated_time"].getInt
|
||||
j_note.is_conflict = joplin_note_Json["is_conflict"].getInt
|
||||
j_note.latitude = joplin_note_Json["latitude"].getFloat
|
||||
j_note.longitude = joplin_note_Json["longitude"].getFloat
|
||||
j_note.altitude = joplin_note_Json["altitude"].getFloat
|
||||
j_note.is_todo = joplin_note_Json["is_todo"].getInt
|
||||
j_note.todo_due = joplin_note_Json["todo_due"].getInt
|
||||
j_note.todo_completed = joplin_note_Json["todo_completed"].getInt
|
||||
j_note.order = joplin_note_Json["order"].getFloat
|
||||
j_note.user_created_time = joplin_note_Json["user_created_time"].getInt
|
||||
j_note.user_updated_time = joplin_note_Json["user_updated_time"].getInt
|
||||
j_note.encryption_cipher_text = joplin_note_Json[
|
||||
"encryption_cipher_text"].getstr
|
||||
j_note.encryption_applied = joplin_note_Json["encryption_applied"].getInt
|
||||
j_note.markup_language = joplin_note_Json["markup_language"].getInt
|
||||
j_note.is_shared = joplin_note_Json["is_shared"].getInt
|
||||
j_note.master_key_id = joplin_note_Json["master_key_id"].getstr
|
||||
|
||||
|
||||
echo j_note
|
||||
return j_note
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : get all joplin TAGS
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc get_joplin_tags*(token: string): Future[joplin_tags] {.async.} =
|
||||
|
||||
# Variables
|
||||
var j_tags: joplin_tags
|
||||
var has_more: bool = true
|
||||
var page: int = 1
|
||||
var url: string
|
||||
var client = newAsyncHttpClient()
|
||||
var pingCheck: joplin_ping
|
||||
pingCheck = waitFor ping_joplin(token)
|
||||
|
||||
# check the joplin status befor query
|
||||
if pingCheck.ping_status:
|
||||
|
||||
# make sure to check all pages
|
||||
while has_more == true:
|
||||
|
||||
# request joplin API for notebooks
|
||||
url = fmt"http://localhost:41184/tags?page={page}&token={token}"
|
||||
echo("URL tags : ", url)
|
||||
var json = await client.getContent(url)
|
||||
|
||||
# parse jason
|
||||
let joplin_tags_Json = parseJson(json)
|
||||
|
||||
# valider qu'il n'y a plus de page
|
||||
if not joplin_tags_Json["has_more"].getBool:
|
||||
has_more = false
|
||||
|
||||
# store json info into an object
|
||||
var count: int = 1
|
||||
for nb in joplin_tags_Json["items"]:
|
||||
j_tags.id.add(nb["id"].getstr)
|
||||
j_tags.parent_id.add(nb["parent_id"].getstr)
|
||||
j_tags.title.add(nb["title"].getstr)
|
||||
count += 1
|
||||
|
||||
# aller à la page suivante
|
||||
page += 1
|
||||
|
||||
return j_tags
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : get the token from Joplin Terminal
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc get_joplin_cli_token*(): string =
|
||||
var flagName: string = ""
|
||||
var flagValue: string = ""
|
||||
var resultExec = execCmdEx("joplin config api.token")
|
||||
|
||||
if resultExec.exitCode == 0:
|
||||
let param1 = resultExec.output
|
||||
let flagSplit = param1.split(" = ")
|
||||
flagName = flagSplit[0]
|
||||
flagValue = flagSplit[1]
|
||||
|
||||
return flagValue
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : launch any program and get PID
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc launchProgram(app: string = "", workingPath: string = "", arguments: array[
|
||||
2, string]): int {.thread.} =
|
||||
|
||||
var p = startProcess(joinPath(workingPath, app), workingPath, arguments)
|
||||
let pid = p.processID()
|
||||
# var outhdl = outputHandle(p)
|
||||
# var inputhdl = inputHandle(p)
|
||||
# var errhdl = errorHandle(p)
|
||||
return pid
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : Start joplin cli
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc joplin_cli_start*(): int {.thread.} =
|
||||
|
||||
let joplinProcessId = launchProgram("joplin", "/usr/bin/", ["server", "start"])
|
||||
return joplinProcessId
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : stop Joplin Terminal
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc joplin_cli_stop*(): int {.thread.} =
|
||||
let joplinProcessId = launchProgram("joplin", "/usr/bin/", ["server", "stop"])
|
||||
return joplinProcessId
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : check Joplin Terminal staus
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc joplin_cli_status*(): bool =
|
||||
var rc = false
|
||||
var resultExec = execCmdEx("joplin server status")
|
||||
|
||||
if resultExec.exitCode == 0:
|
||||
if "Server is not running" in resultExec.output:
|
||||
echo "Joplin Terminal cli status is down : ", resultExec.output
|
||||
rc = false
|
||||
else:
|
||||
echo "Joplin Terminal cli status is up : ", resultExec.output
|
||||
rc = true
|
||||
else:
|
||||
echo "Error validate joplin terminal status : ", resultExec.output
|
||||
return rc
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : start or stop Joplin Terminal
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc joplin_cli_start_stop*(): bool =
|
||||
var idExec: int = 0
|
||||
var isStart: bool = false
|
||||
var sleep_delay_frame: int = 50
|
||||
# var sleep_max: int = 5000
|
||||
|
||||
if joplin_cli_status() == false:
|
||||
idExec = joplin_cli_start()
|
||||
while joplin_cli_status() == false:
|
||||
sleep(sleep_delay_frame)
|
||||
echo "Joplin client Terminal started: ", idExec
|
||||
isStart = true
|
||||
|
||||
else:
|
||||
echo "Joplin client Terminal is alredy started !"
|
||||
#if joplin_cli_status() == true:
|
||||
idExec = joplin_cli_stop()
|
||||
while joplin_cli_status() == true:
|
||||
sleep(sleep_delay_frame)
|
||||
echo "Joplin client Terminal stopped: ", idExec
|
||||
isStart = false
|
||||
|
||||
return isStart
|
||||
|
||||
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC :
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
|
||||
# proc get_joplin_tags_json*(token:string): Future[] {.async.} =
|
||||
|
||||
# # url = fmt"http://localhost:41184/notes/{id}?fields=id,parent_id,title,body,created_time,updated_time,is_conflict,latitude,longitude,altitude,author,source_url,is_todo,todo_due,todo_completed,source,source_application,application_data,order,user_created_time,user_updated_time,encryption_cipher_text,encryption_applied,markup_language,is_shared,share_id,conflict_original_id,master_key_id&token={token}"
|
||||
|
||||
# # url = fmt"http://localhost:41184/tags/{id}?fields=id,parent_id,title,created_time,updated_time,user_created_time,user_updated_time,is_shared&token={token}"
|
||||
|
||||
# # http://localhost:41184/tags?token=e5f6644fbf6a97ddc55648dae72b11caecda6c6642d8ce0d3b20129b89b196385737eb908923542c3343649ebbf865b55bda031ab4c3a16edc7723ef2ad77d8f
|
||||
|
||||
# # Variables
|
||||
# var j_tags: joplin_tags
|
||||
# var has_more: bool = true
|
||||
# var page: int = 1
|
||||
# var url: string
|
||||
# var client = newAsyncHttpClient()
|
||||
# var pingCheck: joplin_ping
|
||||
# pingCheck = waitFor ping_joplin(token)
|
||||
|
||||
|
||||
# # check the joplin status befor query
|
||||
# if pingCheck.ping_status:
|
||||
|
||||
# # make sure to check all pages
|
||||
# while has_more == true:
|
||||
|
||||
# # request joplin API for notebooks
|
||||
# url = fmt"http://localhost:41184/tags?page={page}&token={token}"
|
||||
# echo("URL tags : ", url)
|
||||
# var json = await client.getContent(url)
|
||||
|
||||
# # parse jason
|
||||
# let joplin_tags_Json = parseJson(json)
|
||||
|
||||
# # valider qu'il n'y a plus de page
|
||||
# if not joplin_tags_Json["has_more"].getBool:
|
||||
# has_more = false
|
||||
|
||||
# # store json info into an object
|
||||
# var count: int = 1
|
||||
# for nb in joplin_tags_Json["items"]:
|
||||
# echo nb["id"].getstr
|
||||
# echo nb["parent_id"].getstr
|
||||
# echo nb["title"].getstr
|
||||
# count += 1
|
||||
|
||||
# # aller à la page suivante
|
||||
# page += 1
|
||||
|
||||
|
132
outils/db/database_utils.nim
Normal file
132
outils/db/database_utils.nim
Normal file
@ -0,0 +1,132 @@
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
# Bruno Charest
|
||||
# 2022-08-09
|
||||
#
|
||||
# __ DESCRIPTIONS __
|
||||
# database_utils : procedure related to database
|
||||
#
|
||||
# Inspiration of : https://ttj.dk/blog/2019/01/20/setup-a-website-with-nim
|
||||
# Copyright 2019 - Thomas T. Jarløv
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
|
||||
import os
|
||||
import logging
|
||||
import parsecfg
|
||||
import db_sqlite
|
||||
|
||||
import ../commun/password_utils
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : Generate Database
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc generateDB*() =
|
||||
echo "Generating database"
|
||||
|
||||
# Load the connection details
|
||||
let
|
||||
dict = loadConfig("config/config.cfg")
|
||||
db_user = dict.getSectionValue("Database", "user")
|
||||
db_pass = dict.getSectionValue("Database", "pass")
|
||||
db_name = dict.getSectionValue("Database", "name")
|
||||
db_host = dict.getSectionValue("Database", "host")
|
||||
db_folder = dict.getSectionValue("Database", "folder")
|
||||
dbexists = if fileExists(db_host): true else: false
|
||||
|
||||
if dbexists:
|
||||
echo " - Database already exists. Inserting tables if they do not exist."
|
||||
|
||||
# Creating database folder if it doesn't exist
|
||||
discard existsOrCreateDir(db_folder)
|
||||
|
||||
# Open DB
|
||||
echo " - Opening database"
|
||||
var db = open(connection = db_host, user = db_user, password = db_pass,
|
||||
database = db_name)
|
||||
|
||||
# Person table contains information about the
|
||||
# registrered users
|
||||
if not db.tryExec(sql("""
|
||||
create table if not exists person(
|
||||
id integer primary key,
|
||||
name varchar(60) not null,
|
||||
password varchar(300) not null,
|
||||
email varchar(254) not null,
|
||||
creation timestamp not null default (STRFTIME('%s', 'now')),
|
||||
modified timestamp not null default (STRFTIME('%s', 'now')),
|
||||
salt varbin(128) not null,
|
||||
status varchar(30) not null,
|
||||
timezone VARCHAR(100),
|
||||
secretUrl VARCHAR(250),
|
||||
lastOnline timestamp not null default (STRFTIME('%s', 'now'))
|
||||
);""")):
|
||||
echo " - Database: person table already exists"
|
||||
|
||||
# Session table contains information about the users
|
||||
# cookie ID, IP and last visit
|
||||
if not db.tryExec(sql("""
|
||||
create table if not exists session(
|
||||
id integer primary key,
|
||||
ip inet not null,
|
||||
key varchar(300) not null,
|
||||
userid integer not null,
|
||||
lastModified timestamp not null default (STRFTIME('%s', 'now')),
|
||||
foreign key (userid) references person(id)
|
||||
);""")):
|
||||
echo " - Database: session table already exists"
|
||||
|
||||
# Sesion table contains information about the search
|
||||
#
|
||||
if not db.tryExec(sql("""
|
||||
create table if not exists search(
|
||||
id integer primary key,
|
||||
search_title varchar(300) not null,
|
||||
query varchar(300) not null,
|
||||
search_type varchar(100) not null,
|
||||
creation timestamp not null default (STRFTIME('%s', 'now')),
|
||||
lastModified timestamp not null default (STRFTIME('%s', 'now')),
|
||||
foreign key (userid) references person(id)
|
||||
);""")):
|
||||
echo " - Database: search table already exists"
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : Create Administrator User
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc createAdminUser*(db: DbConn, args: seq[string]) =
|
||||
## Create new admin user
|
||||
|
||||
var iName = ""
|
||||
var iEmail = ""
|
||||
var iPwd = ""
|
||||
|
||||
# Loop through all the arguments and get the args
|
||||
# containing the user information
|
||||
for arg in args:
|
||||
if arg.substr(0, 1) == "u:":
|
||||
iName = arg.substr(2, arg.len())
|
||||
elif arg.substr(0, 1) == "p:":
|
||||
iPwd = arg.substr(2, arg.len())
|
||||
elif arg.substr(0, 1) == "e:":
|
||||
iEmail = arg.substr(2, arg.len())
|
||||
|
||||
# If the name, password or emails does not exists
|
||||
# return error
|
||||
if iName == "" or iPwd == "" or iEmail == "":
|
||||
error("Missing either name, password or email to create the Admin user.")
|
||||
|
||||
# Generate the password using a salt and hashing.
|
||||
# Read more about hashing and salting here:
|
||||
# - https://crackstation.net/hashing-security.htm
|
||||
# - https://en.wikipedia.org/wiki/Salt_(cryptography)
|
||||
let salt = makeSalt()
|
||||
let password = makePassword(iPwd, salt)
|
||||
|
||||
# Insert user into database
|
||||
if insertID(db, sql"INSERT INTO person (name, email, password, salt, status) VALUES (?, ?, ?, ?, ?)",
|
||||
$iName, $iEmail, password, salt, "Admin") > 0:
|
||||
echo "Admin user added"
|
||||
else:
|
||||
error("Something went wrong")
|
||||
|
||||
info("Admin added.")
|
125
outils/web/web_utils.nim
Normal file
125
outils/web/web_utils.nim
Normal file
@ -0,0 +1,125 @@
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
# Bruno Charest
|
||||
# 2022-08-09
|
||||
#
|
||||
# __ DESCRIPTIONS __
|
||||
# web_utils : procedure related web interface
|
||||
#
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
import xlsx # read dashbord.xlsx
|
||||
import jester
|
||||
import ../communication/joplin/joplin_utils
|
||||
import strutils
|
||||
import std/asyncdispatch
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# TYPE : Selected Option for master web page
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type
|
||||
selectedOption* = enum
|
||||
newNote = "New Note", search = "Search", shortcuts = "Shortcuts",
|
||||
notes = "Notes", notebooks = "Notesbooks", tags = "Tags",
|
||||
notes_selectednote = "Notes-SelectedNote", dashbord = "Dashboard"
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# TYPE : Dashbord information
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type DashbordData* = object
|
||||
position*: seq[int]
|
||||
ext_link*: seq[string]
|
||||
int_link*: seq[string]
|
||||
ip_link*: seq[string]
|
||||
title*: seq[string]
|
||||
description*: seq[string]
|
||||
server*: seq[string]
|
||||
ip*: seq[string]
|
||||
port*: seq[int]
|
||||
ssl*: seq[bool]
|
||||
category*: seq[string]
|
||||
icon*: seq[string]
|
||||
open_method*: seq[string]
|
||||
tag*: seq[seq[string]]
|
||||
hotkey*: seq[string]
|
||||
color*: seq[string]
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# Setup user data
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type
|
||||
TData* = ref object of RootObj
|
||||
loggedIn*: bool
|
||||
userid*, username*, userpass*, email*: string
|
||||
notification*: int
|
||||
req*: Request
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# TYPE : Data Informations for Left Colomn
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type ColomnLeftData* = ref object of RootObj
|
||||
j_status*: bool
|
||||
option*: selectedOption
|
||||
j_notes*: joplin_notes
|
||||
j_notes_nb*: int
|
||||
j_notebooks*: joplin_notebooks
|
||||
j_notebooks_nb*: int
|
||||
j_tags*: joplin_tags
|
||||
j_tags_nb*: int
|
||||
dashbord*: DashbordData
|
||||
req*: Request
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
# TYPE : Data Informations for Right Colomn
|
||||
# --==--==--==--==--==--==--==--==--==--==-- #
|
||||
type ColomnRightData* = ref object of RootObj
|
||||
j_status*: bool
|
||||
option*: selectedOption
|
||||
j_SelectedNote*: joplin_note
|
||||
j_notebooksNote*: joplin_notebooks
|
||||
j_tagsNote*: joplin_tags
|
||||
req*: Request
|
||||
|
||||
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
# PROC : get data from dashbord file
|
||||
# --==--==--==--==--==--==--==--==--==--==--==--==--==--==-- #
|
||||
proc getDashbordData*(): Future[DashbordData] {.async.} =
|
||||
|
||||
var ddata: DashbordData
|
||||
var tagslist: seq[string]
|
||||
|
||||
let
|
||||
data = parseExcel("data/dashbord.xlsx", header = true)
|
||||
sheetName = "dashbord"
|
||||
#echo data[sheetName]
|
||||
|
||||
let rows = data[sheetName].toSeq(true)
|
||||
echo rows.len()
|
||||
for i in 0..(rows.len()-1):
|
||||
ddata.position.add(parseInt(rows[i][0]))
|
||||
ddata.ext_link.add(rows[i][1])
|
||||
ddata.int_link.add(rows[i][2])
|
||||
ddata.ip_link.add(rows[i][3])
|
||||
ddata.title.add(rows[i][4])
|
||||
ddata.description.add(rows[i][5])
|
||||
ddata.server.add(rows[i][6])
|
||||
ddata.ip.add(rows[i][7])
|
||||
ddata.port.add(parseInt(rows[i][8]))
|
||||
if rows[i][9] == "OUI":
|
||||
ddata.ssl.add(true)
|
||||
else:
|
||||
ddata.ssl.add(false)
|
||||
|
||||
ddata.category.add(rows[i][10])
|
||||
ddata.icon.add(rows[i][11])
|
||||
ddata.open_method.add(rows[i][12])
|
||||
|
||||
tagslist = rows[i][13].split(',')
|
||||
|
||||
ddata.tag.add(tagslist)
|
||||
ddata.hotkey.add(rows[i][14])
|
||||
ddata.color.add(rows[i][15])
|
||||
|
||||
echo ddata
|
||||
return ddata
|
11
tests/test_execCmd.nim
Normal file
11
tests/test_execCmd.nim
Normal file
@ -0,0 +1,11 @@
|
||||
import osproc
|
||||
|
||||
proc runCommand(cmd: string) =
|
||||
let (output, exitCode) = execCmdEx(cmd)
|
||||
echo "Command:", cmd
|
||||
echo "Output:", output
|
||||
echo "Exit code:", exitCode
|
||||
|
||||
runCommand("echo Hello")
|
||||
runCommand("ls -l")
|
||||
runCommand("invalid command")
|
41
tests/test_object.nim
Normal file
41
tests/test_object.nim
Normal file
@ -0,0 +1,41 @@
|
||||
type
|
||||
PortState = enum Open, Closed
|
||||
PortItem = object
|
||||
port: int
|
||||
state: PortState
|
||||
|
||||
# A simple container for PortItems
|
||||
type
|
||||
PortList = seq[PortItem]
|
||||
|
||||
# Add a new port to the list
|
||||
proc addPort(portList: var PortList; newPort: PortItem) =
|
||||
portList.add(newPort)
|
||||
|
||||
# Modify an existing port in the list
|
||||
proc modifyPort(portList: var PortList; portNum: int; newState: PortState) =
|
||||
for i in 0..<portList.len:
|
||||
if portList[i].port == portNum:
|
||||
portList[i].state = newState
|
||||
return
|
||||
echo "Port not found."
|
||||
|
||||
# Delete a port from the list
|
||||
proc deletePort(portList: var PortList; portNum: int) =
|
||||
for i in 0..<portList.len:
|
||||
if portList[i].port == portNum:
|
||||
portList.del(i)
|
||||
return
|
||||
echo "Port not found."
|
||||
|
||||
# Sample usage
|
||||
var ports: PortList
|
||||
addPort(ports, PortItem(port: 80, state: PortState.Open))
|
||||
addPort(ports, PortItem(port: 443, state: PortState.Closed))
|
||||
echo ports
|
||||
|
||||
modifyPort(ports, 80, PortState.Closed)
|
||||
echo ports
|
||||
|
||||
deletePort(ports, 443)
|
||||
echo ports
|
Loading…
Reference in New Issue
Block a user