PHP User Class [x_class_user]Documentations

This is the Documentation for the Bugfish Framework!




Documentation

The x_class_user PHP class stands as a versatile and comprehensive solution, effortlessly embedding user management into a wide array of web projects. By seamlessly supporting cookies, it ensures smooth and persistent user experiences across visits. This solution boasts user registration and authentication, including secure password hashing. Additionally, it facilitates profile customization with support for user groups and extra fields, providing tailored interactions.

The class further facilitates seamless management of user activities with capabilities such as email-based activation codes for changing email addresses, password recovery through activation codes, and secure login procedures. By leveraging PHP sessions, it ensures consistent user authentication throughout browsing sessions.

To enable the class's functionality, MySQL is required for data storage. Notably, the class is designed with security in mind, offering protection against MySQL injection. However, it's important to note that while it prioritizes security, no solution can guarantee absolute immunity to potential threats.

⚠️ Does use Session-Cookies
⚠️ Does use Cookies (if enabled)
⚠️ Does use MySQL (x_class_mysqli object)
⚠️ Tables will be automatically installed


Table Structure

Below you can find a list of tables created by this class, group classes will only get created if they are activated with configuration functions!

Session Table

Table to store Sessions and User Tokens!

Column Name Data Type Nullable Default Value Comment
id int(10) No AUTO_INCREMENT Unique Session ID
fk_user int(10) No Related User ID
key_type tinyint(1) Yes 0 1 - activate
2 - session
3 - recover
4 - mailchange
creation datetime Yes CURRENT_TIMESTAMP Creation Date for max Session Days
modification datetime Yes CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP Modification Date
refresh_date datetime Yes NULL Last Use Date set by session_restore!
session_key varchar(128) Yes Session Authentication Token and Key!
is_active tinyint(1) Yes 0 1 - Active
0 - Expired
request_ip varchar(128) Yes NULL Requested IP if enabled set at creation!
execute_ip varchar(128) Yes NULL Executed IP if enabled set at Invalidation!
Primary Key (id)

Users Table

Table to store Users and user Settings!

Column Name Data Type Nullable Default Value Comment
id int No AUTO_INCREMENT Unique ID
user_name varchar(512) Yes 'undefined' Users Name for Login if Ref
user_initial int(1) Yes 0 1 if this user is the initial created user
user_pass varchar(512) Yes NULL Users Pass for Login
user_mail varchar(512) Yes NULL Users Mail for Login if Ref
user_shadow varchar(512) Yes NULL Users Store for Mail if Renew
user_rank int(9) Yes NULL Users Rank
user_confirmed tinyint(1) Yes 0 User Activation Status
req_activation datetime Yes NULL Activation Date Counter for new Requests
last_activation datetime Yes NULL Activation Date Counter for new Requests
user_disabled int(1) Yes 0 1 - User is Disabled
last_login datetime Yes NULL Last Login Date
user_blocked tinyint(1) Yes 0 User Blocked Status
block_reset int(1) Yes NULL Block Resets for this user
block_auto int(1) Yes 0 Has this user been automatically blocked?
block_activation int(1) Yes NULL Block Activation for this User
block_mail_edit datetime Yes NULL Block Mail Edits for this User
fails_in_a_row int(10) Yes 1 Fail Pass Enters without Success Login
last_block datetime Yes NULL Block Date for this user
user_lang varchar(24) Yes NULL User Default Language
user_color varchar(24) Yes NULL User Default Color
user_theme varchar(24) Yes NULL User Default Theme
user_theme_sub varchar(24) Yes NULL User Default Sub Theme
extradata TEXT Yes NULL Additional Data
hive_extradata TEXT Yes NULL Additional Data for HIVE System
req_reset datetime Yes NULL Reset Date Counter for new Requests
last_reset datetime Yes NULL Reset Date Counter for new Requests
req_mail_edit datetime Yes NULL Last Mail Change Request Date
last_mail_edit datetime Yes NULL Last Mail Change Request Date
last_activity datetime Yes NULL Last Activity on Site of User
created_date datetime Yes CURRENT_TIMESTAMP Creation Date
modify_date datetime Yes CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP Modification Date
Primary Key (id)

Group Tables

One Group table for the groups themselves, the other for relations between groups and users!

Column Name Data Type Nullable Default Value Comment
id int(10) No AUTO_INCREMENT Unique Group ID
group_name varchar(255) No Group Name
group_description TEXT Yes NULL Group Description
creation datetime Yes CURRENT_TIMESTAMP Creation Date
modification datetime Yes CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP Modification Date
Primary Key (id)
Column Name Data Type Nullable Default Value Comment
id int(10) No AUTO_INCREMENT Unique Link ID
fk_user int(10) No Related User ID
fk_group int(10) No Related Group ID
creation datetime Yes CURRENT_TIMESTAMP Creation Date
Primary Key (id)
Unique Constraint UNIQUE (`fk_user`,`fk_group`)

Extrafield Tables

Table Structure for Extrafields!

Column Name Data Type Nullable Default Value Comment
id int(10) No AUTO_INCREMENT Unique Group ID
fk_user int(10) No Related User ID
... ... ... ... Set your own extrafields with functions!
creation datetime Yes CURRENT_TIMESTAMP Creation Date
modification datetime Yes CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP Modification Date
Primary Key (id)

User Related Parameters

This parameters are only set if a user if logged in!
Parameter Name Description
 user_name
name
 If user is logged in, this contains the user_name as set in database
 user_mail
mail
 If user is logged in, this contains the user_mail as set in database
 theme
user_theme
 If user is logged in, this contains the user_theme as set in database
 lang
user_lang
 If user is logged in, this contains the user_lang as set in database
 loggedIn
loggedin
user_loggedin
user_loggedIn
 If user is logged in, this is true, otherwhise false
 user() Array with all Fields from Database with Users in it.
(Not with data from extrafield or group table)
 user_id
id
 If user is logged in, this contains the user_id as set in database
 user_rank
rank
 If user is logged in, this contains the user_rank as set in database

Reference Functions Return Vars

This variables are set if main operation functions like login/recover/mail change are triggers, to get datas like the user mail or id to quickly send mails to him!
Reference Return Variables Description
$mail_ref_user Contains references relating involved user id after major operation has been triggered.
$mail_ref_token Contains references relating involved user token for activation after major operation has been triggered and serves one.
$mail_ref_receiver Contains references relating involved user mail after major operation has been triggered.
$ref Contains references relating involved user after major operation has been triggered.

Operation Functions Return Vars

This vars will be set after a major function (mail change, recover, login) has been triggered and will be have the same content as the result the related function returns.
Reference Return Variables (outdated) Description
$login_request_code Return Code out of Login Functions (same like result it gives back)
$rec_request_code Return Code out of Recover Functions (same like result it gives back)
$act_request_code Return Code out of Activation Functions (same like result it gives back)
$mc_request_code Return Code out of Mail Change Functions (same like result it gives back)

Constructing Functions

Constructor Function Description
__construct($mysqlcon, $table_users, $table_sessions, $preecokie = "xusers", $initial_ref = false, $initial_pass = false, $initial_rank = false) Construct with x_class_mysql object and Table names (will be auto-generated) Tables are for Users, Sessions. If wanted initial username(ref) and Password can be added! Will only be added on re-install of sql table (auto generated). To an inital User to be created all variables needs to be filled!

$mysqlcon -> x_class_mysql object
$table_users -> Table Name for the Users Table to be generated
$table_sessions -> Table Name for the Sessions table to be generated
$preecokie -> Precookie for Multi Login (Multi Instance Functionality)
$initial_ref -> If Inital Setup, First Admin Username/Usermail to be added to Database
$initial_pass -> Initial User Password
$initial_rank -> Initial User Rank

Configuration Functions

Run this functions before init() to adjust login class settings for your site!

General Login Class Config Function Description
multi_login($bool = false) Allow Multi Login? If this is "false" users will be logged out in the first session if they log in at another location. If this is set to "true" users can login multiple times in different browsers.
login_recover_drop($bool = false) Deactivate Password Reset Token on Successfull Login. If this is "true" - Reset tokens which may have been created will be disabled if the user is logged in or does loggin successfully.
login_field_manual($string) Choose Custom Login Field which should be unique! This can be "user_name" "user_mail" or the reference like a userid you have set for this user. You do not need to setup this, this can be ignored if you do not need it.
login_field_user() User is for Login Primary(Unique). If you set this to true, the primary login for users will be the user_name.
login_field_mail() Mail is for Login Primary(Unique) If you set this to true, the primary login for users will be the user_mail.
mail_unique($bool = false) Mails are unique if this is set to true. If you set this to false mails are not unique. May gets overwritten if user_mail is the default login option, than its forced unique!
user_unique($bool = false) User Names are unique if this is set to true. If you set this to false User Names are not unique. May gets overwritten if User Names is the default login option, than its forced unique!
Config: Log Functions Description
log_ip($bool=false) Log IPs in Database for Sessions? True = Yes / False = No
log_activation($bool=false) Log Activation Session Table? If this is set to false - used keys will be deleted. If this is true, they will be preserved.
log_session($bool=false) Log Session Session Table If this is set to false - used keys will be deleted. If this is true, they will be preserved.
log_recover($bool=false) Log Recover in Session Table If this is set to false - used keys will be deleted. If this is true, they will be preserved.
log_mail_edit($bool=false) Log Mail Edits in Session Table If this is set to false - used keys will be deleted. If this is true, they will be preserved.
Config: Operation Delay Interval Functions Description
wait_activation_min($int = 6) Activate Request Interval Minutes - The time the users need to wait between Activation Operations to start another Operation (against flooding)
wait_recover_min($int = 6) Recover Request Interval Minutes - The time the users need to wait between Recover Operations to start another Operation (against flooding)
wait_mail_edit_min($int = 6) Mail Edit Request Interval Minutes - The time the users need to wait between Mail Change by User with Activation Operations to start another Operation (against flooding)
Config: Token Expire Functions Description
min_activation($int = 6) Activate Token Expire Minutes - The time Activation Keys doe expire in after.
min_recover($int = 6) Recover Token Expire Minutes - The time Recover Keys doe expire in after.
min_mail_edit($int = 6) Mail Edit Token Expire Minutes - The time Mail Change Activation Keys doe expire in after.
Config: Autoblock Functions Description
autoblock($int = false) Activate Auto Block of User after X failed Logins with wrong password, false for deactivation of this function.
Config: Session Functions Description
sessions_days($int = 7) Session Valid for X Days. This defines how long sessions are max valid in days
Config: Cookie Functions Description
cookies_use($bool = true) Allow Use of Cookies - if this is set to yes, cookies are activated and a "remember me" login function can work with cookies. See login_request function for cookie parameter. If this is set to false - no cookies will than be used.
cookies_days($int = 7) Cookies valid for X Days. This defines how long sessions are max valid in days if not refreshed.
Token Config Functions Description
token_charset($charset = "0123456789") Change Token Charset
token_length($length = 24) Change Token Length - Change the default Length of generated Tokens
session_length($length = 24) Change Session Length - Change the Length for generated Session tokens
session_charset($charset = "0123456789") Change Session Charset - Change the Charset for generated Tokens

User Table Change Functions

User Extrafield Functions Description
user_add_field($addstring) Add a Field to Users Table (Column with Column Add String after "ADD COLUMN IF NOT EXISTS ***"
user_del_field($fieldname) Delete a Field from Users Table (CAUTION that does delete data!)

Usergroup Functions

Group Functions Description
groups($table_group, $table_group_link) Enable Usergroups Functionality, Provide name of Group and Relations Table, they will be generated and installed by this class.
group_add($name, $description = "") Create a Group with Name and Description (optional)
group_del($id) Delete a Group with ID
group_users($groupid) Get all Users for a Group in an Array which represents all the relations Table fields (Multi Array)
user_groups($userid) Get all Groups for a User in an array which represents the user group fields of every group in a multi array.
group_adduser($groupid, $userid) Add a user to a group with User and Group ID
group_deluser($groupid, $userid) Delete a User from a Group with User and Group ID
groups_del_field($fieldname) Delete a Group Table Field Name providing the column name.
groups_add_field($fieldstring) Add a Field to Group Table (Column with Column Add String after "ADD COLUMN IF NOT EXISTS ***"

Password Filtering Functions

Password Filter Function Description
passfilter($signs = 6, $capitals = 0, $small = 0, $special = 0, $number = 0) Setup Password Filter Check Variable, the parameters represent the required minimum of needed characters, for example numbers, special chars and capital letters.
passfilter_check($passclear) Check String is confirming the passfilters set rules on passfilter()

Password Functions

Password Functions Description
password_gen($len = 12, $comb = "abcde12345") Generate a Key with Charset[Comb String] and Length, you can use this anywhere you want if you need to generate a password or another random string!
password_crypt($var, $hash = PASSWORD_BCRYPT) Crypt a Cleartext Password - Crypt a Cleartext password to Hashed password. You do not need to do this if you work with this frameworks functions. In case this is needed, this framework will do it by itself. All passwords are default Bcrypt hashed!
password_check($cleartext, $crypted) Check Crypted Password Validation - provide the crypted hashed password and a cleartext password and validity will be checked using this classes conforming bcrypt method, in which passwords are saved in the database.

Extrafield Functions

Extrafield Functions Description
extrafields($table_ext) Activate Extrafield Functionality by providing a table name, which will be generated and installed automatically.
extrafield_del_field($fieldname) Delete a Extrafield Table Field Name providing the column name.
extrafield_add_field($fieldstring) Add a Field to Extrafield Table (Column with Column Add String after "ADD COLUMN IF NOT EXISTS ***"
extrafield_get($id) Get Extrafield Array for a user

Check Token Validation Time Left Functions

Get Expire Time for Request Functions in Seconds (Interval) Description
activation_request_time($user) Get Time till next Request Possible with user id
recover_request_time($user) Get Time till next Request Possible with user id
mail_edit_request_time($user) Get Time till next Request Possible with user id

Check Token Valid Functions

Check Token Validation Functions Description
activation_token_valid($user, $token) Check if Act Token Valid by providing the related user id and the token
recover_token_valid($user, $token) Check if Recover Token Valid by providing the related user id and the token
mail_edit_token_valid($user, $token) Check if Mail Edit Token Valid by providing the related user id and the token
session_token_valid($user, $token) Check if Session Token Valid by providing the related user id and the token

User Operation Functions

If you do not provide an ID here, the actual logged in executing user will be changed or handled as id. In case the id is optional this will be the handling for that kind of execution or trigger of that functions listed below.

User Operation Functions Description
get($id = false) Get User informations from Table in Array
exists($id = false) Check if user with id exists
delete($id = false) Delete User
disable_user_session($id = false) Disable a Users Session
delete_user_session($id = false) Delete a Users Session
logout_all() Logout all Users
confirmed_user($id = false) Check User Confirmation State, if the user account is confirmed this will give back "true"
addUser($nameref, $mail, $password = false, $rank = false, $activated = false)
add_user
Add a New User to the database.

If Mail is unique, this does delete never used, registered accounts with that mail as Shadow Mails on Users with that mail. If $activated is true the user wont need any additional activation. You can define the users rank, password, mail and may the user reference, which can represnt the mail for the new created user.

Block Functions

User Block Functions Description
blocked_user($id = false) Is User Blocked? True if Yes, False if no.
block_user($id = false) Block a User
unblock_user($id = false) Unblock a User

Enable/Disable Functions

User Disable Functions Description
disabled_user($id = false) Is User Disabled? True if Yes, False if no.
disable_user($id = false) Disable a User
enable_user($id = false) Enable a User

Change User Functions

User Change Functions Description
change_pass($id = false, $new = false)
change_password
changeUserPass
Change User Pass
change_rank($id = false, $new = false) Change User Rank
changeUserName($id = false, $new)
change_name
Change User Name
changeUserShadowMail($id = false, $new)
change_shadow
Change a Users Shadow Mail (This is the Mail which is not activated Yet but he user registered new and awaits activation)
changeUserMail($id = false, $new)
change_mail
Change a Users Mail

AIf Mail is unique, this does delete never used, registered accounts with that mail as Shadow Mails on Users with that mail!

Duplicate Check Functions

Reference Existance Checks Description
refExists($ref)
ref_exists
Check if ref Exists
refExistsActive($ref)
ref_exists_active
Check if Ref Exists confirmed User
usernameExists($ref)
username_exists
Check if username exists
usernameExistsActive($ref)
username_exists_active
Check if Username Exists confirmed User
mailExists($ref)
mail_exists
Check if Mail Exists
mailExistsActive($ref)
mail_exists_active
Check if Mail Exists Confirmed User

Extra Data Functions

Extra Data Functions Description
get_extra($id= false) Get extradata as array from user (You can store your own data for user here in an array if needed, there is an extradata field in users table)
set_extra($id= false, $array) Set extra data from array for user (You can store your own data for user here in an array if needed, there is an extradata field in users table)

Login As Functions

Login As Functions Description
login_as($id) Login as User with ID (needs to be logged in when this function is executed, multi login with user logged in at same time normally is possible!
login_as_return() Return to normal State after login_as() function has been successfully executed
login_as_is() True if current user is masked logged in as another user with login_as() function. False if current user is normally logged in!

Primary Functions

Primary Functions Description
logout() Logout the Current Logged In User
init() Init the Login with all Configs (Should run once after Configuration has been changed with adjustment functions. This will create all needed session and restore the login if already logged in. Without this function executed after the configuration, nothing will work!
login_request($ref, $pass, $cookies= false) Request Login with Reference, Pass and Want stay online? (cookies)
Return Code: 1 - Login Successfull
Return Code: 2 -Ref does not exist
Return Code: 3 - Wrong Password
Return Code: 4 - User Blocked
Return Code: 5 - User not confirmed
Return Code: 6- Pass Wrong and User Auto-Blocked after X tries (if activated)
Return Code: 7- User is Disabled

Activation Functions

Activation Functions Description
activation_request_id($id) Activation Requests without Interval Limits with User ID

Administrator can Request Activation for Users without Interval Checks
Request Activation for Account with ID (fills Ref for example Mail Sending)
1 - Successfull
2 - Ref Not Found
3 - Already Active User ID

activation_request($ref) Request Activation for Account with Ref from User (fills Ref for example Mail Sending)
1 - Successfull
2 - Ref Not Found
3 - Interval not Reached between new Activation Requests
4 - Already Active User ID
5 - Activation for this user is blocked
6 - User is Disabled
activation_confirm($userid, $token, $newpass = false) Activate with Userid and Valid Token
1 - Successfull Created
2 - Reference not Found
3 - Token Invalid
4 - Activation Blocked for this user

Account Recover Functions

Reset Functions Description
recover_request_id($id) Recover Request for Account ID (fills Ref for example Mail Sending)
1 - Successfull Created
2 - Reference not Found
recover_request($ref) Recover Request for User by Ref (fills Ref for example Mail Sending)
1 - Successfull
2 - Reference not found
3 - Interval not Reached
4 - User Blocked for Resets
5 - User is Disabled
recover_confirm($userid, $token, $newpass) Confirm Recover with new Password, Token and UseriD (fills Ref for example Mail Sending)
1 - Successfull
2 - Reference not found
3 - Token Error
4 - User Blocked for Resets

Mail change with Confirmation Functions

Mail Edit Functions Description
mail_edit($id, $newmail, $nointervall = false) Create New Shadow Mail
1 - Success
2 - Reference Not Found
3 - Interval for new Request not Reached
4 - Mail Exists
5 - User Blocked for Mail Change
6 - User is Disabled
mail_edit_confirm($userid, $token, $run = true) Confirm Mail Edit
1 - Success
2 - Reference Not Found
3 - Token Expired
4 - Mail Exists Shadow Removed in Meantime
5 - User Blocked for Mail Change
6 - Change User Mail Function Error / Mail Exists or is already for User

Templates for Login and Execution Forms

Functions below can spare you the work to build own login html elements!

Display Function (optional) Description
display_return_code Contains Return Code for Display Form Functions. See the Function which is refered to in below instructions!
display_login($spawn_register_button = array("url" => "", "label" => "Register Now"), $spawn_cookie_checkbox = "Stay Logged In?", $spawn_reset_button = array("url" => "", "label" => "Reset Account"), $login_button_label = "Login", $label = array("ref_placeholder" => "Please enter your E-Mail", "ref_label" => "E-Mail", "pass_label" => "Password", "pass_placeholder" => "Please enter your password!"), $captcha = array("url" => "captcha.jpg", "code" => "243fsdfsfds")) Display Login Template, returns in display_return_code the output of login_request()...
This function will spawn a fully functional login page. As this is not widely used, this function is not explained here in detail. You can make your own login area and use this class to handle all necesary things yourself. This class will take a lot of user management related work in backend away from you.

How to get support?

There are different ways to get support for our products. You can write comments in our specific websites section for the related product, but the best way it to write in our forum, as we are getting notifications about that! So if you need any help, sign in at our forum and we will do what we can to serve you. If you do not want to register at our forum, you are invited to write us for support at requests@bugfish.eu.

My Website My Forum

License Informations

License Informations of this Class

GNU GENERAL PUBLIC LICENSE

Version 3, 29 June 2007

Copyright © 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>.


License Informations of this Github Page

Designed with love by Xiaoying Riley for developers
(And modified by bugfish)
You are only allowed to use this template if you include this attribution!