]> git.mxchange.org Git - friendica.git/blobdiff - doc/database/db_user.md
Merge remote-tracking branch 'upstream/develop' into api-edit
[friendica.git] / doc / database / db_user.md
index e9306f8c5a9f2228bc05f8657cd122732219705c..7f58ce58f1573f066db0be0f47ec0ebd5bc9ddea 100644 (file)
@@ -1,78 +1,76 @@
 Table user
-==========
+===========
 
-| Field                    | Description                                                                             | Type                | Null | Key | Default             | Extra          |
-|--------------------------|-----------------------------------------------------------------------------------------|---------------------|------|-----|---------------------|----------------|
-| uid                      | sequential ID                                                                           | int(11)             | NO   | PRI | NULL                | auto_increment |
-| guid                     | A unique identifier for this user                                                       | varchar(64)         | NO   |     |                     |                |
-| username                 | Name that this user is known by                                                         | varchar(255)        | NO   |     |                     |                |
-| password                 | encrypted password                                                                      | varchar(255)        | NO   |     |                     |                |
-| nickname                 | nick- and user name                                                                     | varchar(255)        | NO   | MUL |                     |                |
-| email                    | the users email address                                                                 | varchar(255)        | NO   |     |                     |                |
-| openid                   |                                                                                         | varchar(255)        | NO   |     |                     |                |
-| timezone                 | PHP-legal timezone                                                                      | varchar(128)        | NO   |     |                     |                |
-| language                 | default language                                                                        | varchar(32)         | NO   |     | en                  |                |
-| register_date            | timestamp of registration                                                               | datetime            | NO   |     | 0001-01-01 00:00:00 |                |
-| login_date               | timestamp of last login                                                                 | datetime            | NO   |     | 0001-01-01 00:00:00 |                |
-| default-location         | Default for item.location                                                               | varchar(255)        | NO   |     |                     |                |
-| allow_location           | 1 allows to display the location                                                        | tinyint(1)          | NO   |     | 0                   |                |
-| theme                    | user theme preference                                                                   | varchar(255)        | NO   |     |                     |                |
-| pubkey                   | RSA public key 4096 bit                                                                 | text                | NO   |     | NULL                |                |
-| prvkey                   | RSA private key 4096 bit                                                                | text                | NO   |     | NULL                |                |
-| spubkey                  |                                                                                         | text                | NO   |     | NULL                |                |
-| sprvkey                  |                                                                                         | text                | NO   |     | NULL                |                |
-| verified                 | user is verified through email                                                          | tinyint(1) unsigned | NO   |     | 0                   |                |
-| blocked                  | 1 for user is blocked                                                                   | tinyint(1) unsigned | NO   |     | 0                   |                |
-| blockwall                | Prohibit contacts to post to the profile page of the user                               | tinyint(1) unsigned | NO   |     | 0                   |                |
-| hidewall                 | Hide profile details from unkown viewers                                                | tinyint(1) unsigned | NO   |     | 0                   |                |
-| blocktags                | Prohibit contacts to tag the post of this user                                          | tinyint(1) unsigned | NO   |     | 0                   |                |
-| unkmail                  | Permit unknown people to send private mails to this user                                | tinyint(1)          | NO   |     | 0                   |                |
-| cntunkmail               |                                                                                         | int(11)             | NO   |     | 10                  |                |
-| notify-flags             | email notification options                                                              | int(11) unsigned    | NO   |     | 65535               |                |
-| page-flags               | page/profile type                                                                       | int(11) unsigned    | NO   |     | 0                   |                |
-| prvnets                  |                                                                                         | tinyint(1)          | NO   |     | 0                   |                |
-| pwdreset                 |                                                                                         | varchar(255)        | NO   |     |                     |                |
-| maxreq                   |                                                                                         | int(11)             | NO   |     | 10                  |                |
-| expire                   |                                                                                         | int(11) unsigned    | NO   |     | 0                   |                |
-| account_removed          | if 1 the account is removed                                                             | tinyint(1)          | NO   |     | 0                   |                |
-| account_expired          |                                                                                         | tinyint(1)          | NO   |     | 0                   |                |
-| account_expires_on       | timestamp when account expires and will be deleted                                      | datetime            | NO   |     | 0001-01-01 00:00:00 |                |
-| expire_notification_sent | timestamp of last warning of account expiration                                         | datetime            | NO   |     | 0001-01-01 00:00:00 |                |
-| service_class            | service class for this account, determines what if any limits/restrictions are in place | varchar(32)         | NO   |     |                     |                |
-| def_gid                  |                                                                                         | int(11)             | NO   |     | 0                   |                |
-| allow_cid                | default permission for this user                                                        | mediumtext          | NO   |     | NULL                |                |
-| allow_gid                | default permission for this user                                                        | mediumtext          | NO   |     | NULL                |                |
-| deny_cid                 | default permission for this user                                                        | mediumtext          | NO   |     | NULL                |                |
-| deny_gid                 | default permission for this user                                                        | mediumtext          | NO   |     | NULL                |                |
-| openidserver             |                                                                                         | text                | NO   |     | NULL                |                |
+The local users
 
-```
-/**
-* page-flags
-*/
-define ( 'PAGE_NORMAL',            0 );
-define ( 'PAGE_SOAPBOX',           1 );
-define ( 'PAGE_COMMUNITY',         2 );
-define ( 'PAGE_FREELOVE',          3 );
-define ( 'PAGE_BLOG',              4 );
-define ( 'PAGE_PRVGROUP',          5 );
+Fields
+------
 
-/**
-* notify-flags
-*/
-define ( 'NOTIFY_INTRO',    0x0001 );
-define ( 'NOTIFY_CONFIRM',  0x0002 );
-define ( 'NOTIFY_WALL',     0x0004 );
-define ( 'NOTIFY_COMMENT',  0x0008 );
-define ( 'NOTIFY_MAIL',     0x0010 );
-define ( 'NOTIFY_SUGGEST',  0x0020 );
-define ( 'NOTIFY_PROFILE',  0x0040 );
-define ( 'NOTIFY_TAGSELF',  0x0080 );
-define ( 'NOTIFY_TAGSHARE', 0x0100 );
-define ( 'NOTIFY_POKE',     0x0200 );
-define ( 'NOTIFY_SHARE',    0x0400 );
+| Field                    | Description                                                                       | Type               | Null | Key | Default             | Extra          |
+| ------------------------ | --------------------------------------------------------------------------------- | ------------------ | ---- | --- | ------------------- | -------------- |
+| uid                      | sequential ID                                                                     | mediumint unsigned | NO   | PRI | NULL                | auto_increment |
+| parent-uid               | The parent user that has full control about this user                             | mediumint unsigned | YES  |     | NULL                |                |
+| guid                     | A unique identifier for this user                                                 | varchar(64)        | NO   |     |                     |                |
+| username                 | Name that this user is known by                                                   | varchar(255)       | NO   |     |                     |                |
+| password                 | encrypted password                                                                | varchar(255)       | NO   |     |                     |                |
+| legacy_password          | Is the password hash double-hashed?                                               | boolean            | NO   |     | 0                   |                |
+| nickname                 | nick- and user name                                                               | varchar(255)       | NO   |     |                     |                |
+| email                    | the users email address                                                           | varchar(255)       | NO   |     |                     |                |
+| openid                   |                                                                                   | varchar(255)       | NO   |     |                     |                |
+| timezone                 | PHP-legal timezone                                                                | varchar(128)       | NO   |     |                     |                |
+| language                 | default language                                                                  | varchar(32)        | NO   |     | en                  |                |
+| register_date            | timestamp of registration                                                         | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
+| login_date               | timestamp of last login                                                           | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
+| last-activity            | Day of the last activity                                                          | date               | YES  |     | NULL                |                |
+| default-location         | Default for item.location                                                         | varchar(255)       | NO   |     |                     |                |
+| allow_location           | 1 allows to display the location                                                  | boolean            | NO   |     | 0                   |                |
+| theme                    | user theme preference                                                             | varchar(255)       | NO   |     |                     |                |
+| pubkey                   | RSA public key 4096 bit                                                           | text               | YES  |     | NULL                |                |
+| prvkey                   | RSA private key 4096 bit                                                          | text               | YES  |     | NULL                |                |
+| spubkey                  |                                                                                   | text               | YES  |     | NULL                |                |
+| sprvkey                  |                                                                                   | text               | YES  |     | NULL                |                |
+| verified                 | user is verified through email                                                    | boolean            | NO   |     | 0                   |                |
+| blocked                  | 1 for user is blocked                                                             | boolean            | NO   |     | 0                   |                |
+| blockwall                | Prohibit contacts to post to the profile page of the user                         | boolean            | NO   |     | 0                   |                |
+| hidewall                 | Hide profile details from unkown viewers                                          | boolean            | NO   |     | 0                   |                |
+| blocktags                | Prohibit contacts to tag the post of this user                                    | boolean            | NO   |     | 0                   |                |
+| unkmail                  | Permit unknown people to send private mails to this user                          | boolean            | NO   |     | 0                   |                |
+| cntunkmail               |                                                                                   | int unsigned       | NO   |     | 10                  |                |
+| notify-flags             | email notification options                                                        | smallint unsigned  | NO   |     | 65535               |                |
+| page-flags               | page/profile type                                                                 | tinyint unsigned   | NO   |     | 0                   |                |
+| account-type             |                                                                                   | tinyint unsigned   | NO   |     | 0                   |                |
+| prvnets                  |                                                                                   | boolean            | NO   |     | 0                   |                |
+| pwdreset                 | Password reset request token                                                      | varchar(255)       | YES  |     | NULL                |                |
+| pwdreset_time            | Timestamp of the last password reset request                                      | datetime           | YES  |     | NULL                |                |
+| maxreq                   |                                                                                   | int unsigned       | NO   |     | 10                  |                |
+| expire                   | Delay in days before deleting user-related posts. Scope is controlled by pConfig. | int unsigned       | NO   |     | 0                   |                |
+| account_removed          | if 1 the account is removed                                                       | boolean            | NO   |     | 0                   |                |
+| account_expired          |                                                                                   | boolean            | NO   |     | 0                   |                |
+| account_expires_on       | timestamp when account expires and will be deleted                                | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
+| expire_notification_sent | timestamp of last warning of account expiration                                   | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
+| def_gid                  |                                                                                   | int unsigned       | NO   |     | 0                   |                |
+| allow_cid                | default permission for this user                                                  | mediumtext         | YES  |     | NULL                |                |
+| allow_gid                | default permission for this user                                                  | mediumtext         | YES  |     | NULL                |                |
+| deny_cid                 | default permission for this user                                                  | mediumtext         | YES  |     | NULL                |                |
+| deny_gid                 | default permission for this user                                                  | mediumtext         | YES  |     | NULL                |                |
+| openidserver             |                                                                                   | text               | YES  |     | NULL                |                |
 
-define ( 'NOTIFY_SYSTEM',   0x8000 );
-```
+Indexes
+------------
+
+| Name       | Fields       |
+| ---------- | ------------ |
+| PRIMARY    | uid          |
+| nickname   | nickname(32) |
+| parent-uid | parent-uid   |
+| guid       | guid         |
+| email      | email(64)    |
+
+Foreign Keys
+------------
+
+| Field | Target Table | Target Field |
+|-------|--------------|--------------|
+| parent-uid | [user](help/database/db_user) | uid |
 
 Return to [database documentation](help/database)