diff --git a/CONFIGURE b/CONFIGURE new file mode 100644 index 0000000000..0a3579885c --- /dev/null +++ b/CONFIGURE @@ -0,0 +1,854 @@ +Configuration options +===================== + +The main configuration file for StatusNet (excepting configurations for +dependency software) is config.php in your StatusNet directory. If you +edit any other file in the directory, like lib/default.php (where most +of the defaults are defined), you will lose your configuration options +in any upgrade, and you will wish that you had been more careful. + +Starting with version 0.9.0, a Web based configuration panel has been +added to StatusNet. The preferred method for changing config options is +to use this panel. + +A command-line script, setconfig.php, can be used to set individual +configuration options. It's in the scripts/ directory. + +Starting with version 0.7.1, you can put config files in the +/etc/statusnet/ directory on your server, if it exists. Config files +will be included in this order: + +* /etc/statusnet/statusnet.php - server-wide config +* /etc/statusnet/.php - for a virtual host +* /etc/statusnet/_.php - for a path +* INSTALLDIR/config.php - for a particular implementation + +Almost all configuration options are made through a two-dimensional +associative array, cleverly named $config. A typical configuration +line will be: + + $config['section']['option'] = value; + +For brevity, the following documentation describes each section and +option. + +site +---- + +This section is a catch-all for site-wide variables. + +name: the name of your site, like 'YourCompany Microblog'. +server: the server part of your site's URLs, like 'example.net'. +path: The path part of your site's URLs, like 'statusnet' or '' + (installed in root). +fancy: whether or not your site uses fancy URLs (see Fancy URLs + section above). Default is false. +logfile: full path to a file for StatusNet to save logging + information to. You may want to use this if you don't have + access to syslog. +logdebug: whether to log additional debug info like backtraces on + hard errors. Default false. +locale_path: full path to the directory for locale data. Unless you + store all your locale data in one place, you probably + don't need to use this. +language: default language for your site. Defaults to US English. + Note that this is overridden if a user is logged in and has + selected a different language. It is also overridden if the + user is NOT logged in, but their browser requests a different + langauge. Since pretty much everybody's browser requests a + language, that means that changing this setting has little or + no effect in practice. +languages: A list of languages supported on your site. Typically you'd + only change this if you wanted to disable support for one + or another language: + "unset($config['site']['languages']['de'])" will disable + support for German. +theme: Theme for your site (see Theme section). Two themes are + provided by default: 'default' and 'stoica' (the one used by + Identi.ca). It's appreciated if you don't use the 'stoica' theme + except as the basis for your own. +email: contact email address for your site. By default, it's extracted + from your Web server environment; you may want to customize it. +broughtbyurl: name of an organization or individual who provides the + service. Each page will include a link to this name in the + footer. A good way to link to the blog, forum, wiki, + corporate portal, or whoever is making the service available. +broughtby: text used for the "brought by" link. +timezone: default timezone for message display. Users can set their + own time zone. Defaults to 'UTC', which is a pretty good default. +closed: If set to 'true', will disallow registration on your site. + This is a cheap way to restrict accounts to only one + individual or group; just register the accounts you want on + the service, *then* set this variable to 'true'. +inviteonly: If set to 'true', will only allow registration if the user + was invited by an existing user. +private: If set to 'true', anonymous users will be redirected to the + 'login' page. Also, API methods that normally require no + authentication will require it. Note that this does not turn + off registration; use 'closed' or 'inviteonly' for the + behaviour you want. +notice: A plain string that will appear on every page. A good place + to put introductory information about your service, or info about + upgrades and outages, or other community info. Any HTML will + be escaped. +logo: URL of an image file to use as the logo for the site. Overrides + the logo in the theme, if any. +ssllogo: URL of an image file to use as the logo on SSL pages. If unset, + theme logo is used instead. +ssl: Whether to use SSL and https:// URLs for some or all pages. + Possible values are 'always' (use it for all pages), 'never' + (don't use it for any pages), or 'sometimes' (use it for + sensitive pages that include passwords like login and registration, + but not for regular pages). Default to 'never'. +sslserver: use an alternate server name for SSL URLs, like + 'secure.example.org'. You should be careful to set cookie + parameters correctly so that both the SSL server and the + "normal" server can access the session cookie and + preferably other cookies as well. +shorturllength: ignored. See 'url' section below. +dupelimit: minimum time allowed for one person to say the same thing + twice. Default 60s. Anything lower is considered a user + or UI error. +textlimit: default max size for texts in the site. Defaults to 0 (no limit). + Can be fine-tuned for notices, messages, profile bios and group descriptions. + +db +-- + +This section is a reference to the configuration options for +DB_DataObject (see ). The ones that you may want to +set are listed below for clarity. + +database: a DSN (Data Source Name) for your StatusNet database. This is + in the format 'protocol://username:password@hostname/databasename', + where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you + really know what you're doing), 'username' is the username, + 'password' is the password, and etc. +ini_yourdbname: if your database is not named 'statusnet', you'll need + to set this to point to the location of the + statusnet.ini file. Note that the real name of your database + should go in there, not literally 'yourdbname'. +db_driver: You can try changing this to 'MDB2' to use the other driver + type for DB_DataObject, but note that it breaks the OpenID + libraries, which only support PEAR::DB. +debug: On a database error, you may get a message saying to set this + value to 5 to see debug messages in the browser. This breaks + just about all pages, and will also expose the username and + password +quote_identifiers: Set this to true if you're using postgresql. +type: either 'mysql' or 'postgresql' (used for some bits of + database-type-specific SQL in the code). Defaults to mysql. +mirror: you can set this to an array of DSNs, like the above + 'database' value. If it's set, certain read-only actions will + use a random value out of this array for the database, rather + than the one in 'database' (actually, 'database' is overwritten). + You can offload a busy DB server by setting up MySQL replication + and adding the slaves to this array. Note that if you want some + requests to go to the 'database' (master) server, you'll need + to include it in this array, too. +utf8: whether to talk to the database in UTF-8 mode. This is the default + with new installations, but older sites may want to turn it off + until they get their databases fixed up. See "UTF-8 database" + above for details. +schemacheck: when to let plugins check the database schema to add + tables or update them. Values can be 'runtime' (default) + or 'script'. 'runtime' can be costly (plugins check the + schema on every hit, adding potentially several db + queries, some quite long), but not everyone knows how to + run a script. If you can, set this to 'script' and run + scripts/checkschema.php whenever you install or upgrade a + plugin. + +syslog +------ + +By default, StatusNet sites log error messages to the syslog facility. +(You can override this using the 'logfile' parameter described above). + +appname: The name that StatusNet uses to log messages. By default it's + "statusnet", but if you have more than one installation on the + server, you may want to change the name for each instance so + you can track log messages more easily. +priority: level to log at. Currently ignored. +facility: what syslog facility to used. Defaults to LOG_USER, only + reset if you know what syslog is and have a good reason + to change it. + +queue +----- + +You can configure the software to queue time-consuming tasks, like +sending out SMS email or XMPP messages, for off-line processing. See +'Queues and daemons' above for how to set this up. + +enabled: Whether to uses queues. Defaults to false. +subsystem: Which kind of queueserver to use. Values include "db" for + our hacked-together database queuing (no other server + required) and "stomp" for a stomp server. +stomp_server: "broker URI" for stomp server. Something like + "tcp://hostname:61613". More complicated ones are + possible; see your stomp server's documentation for + details. +queue_basename: a root name to use for queues (stomp only). Typically + something like '/queue/sitename/' makes sense. If running + multiple instances on the same server, make sure that + either this setting or $config['site']['nickname'] are + unique for each site to keep them separate. + +stomp_username: username for connecting to the stomp server; defaults + to null. +stomp_password: password for connecting to the stomp server; defaults + to null. + +stomp_persistent: keep items across queue server restart, if enabled. + Under ActiveMQ, the server configuration determines if and how + persistent storage is actually saved. + + If using a message queue server other than ActiveMQ, you may + need to disable this if it does not support persistence. + +stomp_transactions: use transactions to aid in error detection. + A broken transaction will be seen quickly, allowing a message + to be redelivered immediately if a daemon crashes. + + If using a message queue server other than ActiveMQ, you may + need to disable this if it does not support transactions. + +stomp_acks: send acknowledgements to aid in flow control. + An acknowledgement of successful processing tells the server + we're ready for more and can help keep things moving smoothly. + + This should *not* be turned off when running with ActiveMQ, but + if using another message queue server that does not support + acknowledgements you might need to disable this. + +softlimit: an absolute or relative "soft memory limit"; daemons will + restart themselves gracefully when they find they've hit + this amount of memory usage. Defaults to 90% of PHP's global + memory_limit setting. + +inboxes: delivery of messages to receiver's inboxes can be delayed to + queue time for best interactive performance on the sender. + This may however be annoyingly slow when using the DB queues, + so you can set this to false if it's causing trouble. + +breakout: for stomp, individual queues are by default grouped up for + best scalability. If some need to be run by separate daemons, + etc they can be manually adjusted here. + + Default will share all queues for all sites within each group. + Specify as / or //, + using nickname identifier as site. + + 'main/distrib' separate "distrib" queue covering all sites + 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite' + +max_retries: for stomp, drop messages after N failed attempts to process. + Defaults to 10. + +dead_letter_dir: for stomp, optional directory to dump data on failed + queue processing events after discarding them. + +stomp_no_transactions: for stomp, the server does not support transactions, + so do not try to user them. This is needed for http://www.morbidq.com/. + +stomp_no_acks: for stomp, the server does not support acknowledgements. + so do not try to user them. This is needed for http://www.morbidq.com/. + +license +------- + +The default license to use for your users notices. The default is the +Creative Commons Attribution 3.0 license, which is probably the right +choice for any public site. Note that some other servers will not +accept notices if you apply a stricter license than this. + +type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved' + (default copyright), or 'private' (for private and confidential + information). +owner: for 'allrightsreserved' or 'private', an assigned copyright + holder (for example, an employer for a private site). If + not specified, will be attributed to 'contributors'. +url: URL of the license, used for links. +title: Title for the license, like 'Creative Commons Attribution 3.0'. +image: A button shown on each page for the license. + +mail +---- + +This is for configuring out-going email. We use PEAR's Mail module, +see: http://pear.php.net/manual/en/package.mail.mail.factory.php + +backend: the backend to use for mail, one of 'mail', 'sendmail', and + 'smtp'. Defaults to PEAR's default, 'mail'. +params: if the mail backend requires any parameters, you can provide + them in an associative array. + +nickname +-------- + +This is for configuring nicknames in the service. + +blacklist: an array of strings for usernames that may not be + registered. A default array exists for strings that are + used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme') + but you may want to add others if you have other software + installed in a subdirectory of StatusNet or if you just + don't want certain words used as usernames. +featured: an array of nicknames of 'featured' users of the site. + Can be useful to draw attention to well-known users, or + interesting people, or whatever. + +avatar +------ + +For configuring avatar access. + +dir: Directory to look for avatar files and to put them into. + Defaults to avatar subdirectory of install directory; if + you change it, make sure to change path, too. +path: Path to avatars. Defaults to path for avatar subdirectory, + but you can change it if you wish. Note that this will + be included with the avatar server, too. +server: If set, defines another server where avatars are stored in the + root directory. Note that the 'avatar' subdir still has to be + writeable. You'd typically use this to split HTTP requests on + the client to speed up page loading, either with another + virtual server or with an NFS or SAMBA share. Clients + typically only make 2 connections to a single server at a + time , so this can parallelize the job. + Defaults to null. +ssl: Whether to access avatars using HTTPS. Defaults to null, meaning + to guess based on site-wide SSL settings. + +public +------ + +For configuring the public stream. + +localonly: If set to true, only messages posted by users of this + service (rather than other services, filtered through OStatus) + are shown in the public stream. Default true. +blacklist: An array of IDs of users to hide from the public stream. + Useful if you have someone making excessive Twitterfeed posts + to the site, other kinds of automated posts, testing bots, etc. +autosource: Sources of notices that are from automatic posters, and thus + should be kept off the public timeline. Default empty. + +theme +----- + +server: Like avatars, you can speed up page loading by pointing the + theme file lookup to another server (virtual or real). + Defaults to NULL, meaning to use the site server. +dir: Directory where theme files are stored. Used to determine + whether to show parts of a theme file. Defaults to the theme + subdirectory of the install directory. +path: Path part of theme URLs, before the theme name. Relative to the + theme server. It may make sense to change this path when upgrading, + (using version numbers as the path) to make sure that all files are + reloaded by caching clients or proxies. Defaults to null, + which means to use the site path + '/theme'. +ssl: Whether to use SSL for theme elements. Default is null, which means + guess based on site SSL settings. +sslserver: SSL server to use when page is HTTPS-encrypted. If + unspecified, site ssl server and so on will be used. +sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted. + +javascript +---------- + +server: You can speed up page loading by pointing the + theme file lookup to another server (virtual or real). + Defaults to NULL, meaning to use the site server. +path: Path part of Javascript URLs. Defaults to null, + which means to use the site path + '/js/'. +ssl: Whether to use SSL for JavaScript files. Default is null, which means + guess based on site SSL settings. +sslserver: SSL server to use when page is HTTPS-encrypted. If + unspecified, site ssl server and so on will be used. +sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted. +bustframes: If true, all web pages will break out of framesets. If false, + can comfortably live in a frame or iframe... probably. Default + to true. + +xmpp +---- + +For configuring the XMPP sub-system. + +enabled: Whether to accept and send messages by XMPP. Default false. +server: server part of XMPP ID for update user. +port: connection port for clients. Default 5222, which you probably + shouldn't need to change. +user: username for the client connection. Users will receive messages + from 'user'@'server'. +resource: a unique identifier for the connection to the server. This + is actually used as a prefix for each XMPP component in the system. +password: password for the user account. +host: some XMPP domains are served by machines with a different + hostname. (For example, @gmail.com GTalk users connect to + talk.google.com). Set this to the correct hostname if that's the + case with your server. +encryption: Whether to encrypt the connection between StatusNet and the + XMPP server. Defaults to true, but you can get + considerably better performance turning it off if you're + connecting to a server on the same machine or on a + protected network. +debug: if turned on, this will make the XMPP library blurt out all of + the incoming and outgoing messages as XML stanzas. Use as a + last resort, and never turn it on if you don't have queues + enabled, since it will spit out sensitive data to the browser. +public: an array of JIDs to send _all_ notices to. This is useful for + participating in third-party search and archiving services. + +invite +------ + +For configuring invites. + +enabled: Whether to allow users to send invites. Default true. + +tag +--- + +Miscellaneous tagging stuff. + +dropoff: Decay factor for tag listing, in seconds. + Defaults to exponential decay over ten days; you can twiddle + with it to try and get better results for your site. + +popular +------- + +Settings for the "popular" section of the site. + +dropoff: Decay factor for popularity listing, in seconds. + Defaults to exponential decay over ten days; you can twiddle + with it to try and get better results for your site. + +daemon +------ + +For daemon processes. + +piddir: directory that daemon processes should write their PID file + (process ID) to. Defaults to /var/run/, which is where this + stuff should usually go on Unix-ish systems. +user: If set, the daemons will try to change their effective user ID + to this user before running. Probably a good idea, especially if + you start the daemons as root. Note: user name, like 'daemon', + not 1001. +group: If set, the daemons will try to change their effective group ID + to this named group. Again, a name, not a numerical ID. + +memcached +--------- + +You can get a significant boost in performance by caching some +database data in memcached . + +enabled: Set to true to enable. Default false. +server: a string with the hostname of the memcached server. Can also + be an array of hostnames, if you've got more than one server. +base: memcached uses key-value pairs to store data. We build long, + funny-looking keys to make sure we don't have any conflicts. The + base of the key is usually a simplified version of the site name + (like "Identi.ca" => "identica"), but you can overwrite this if + you need to. You can safely ignore it if you only have one + StatusNet site using your memcached server. +port: Port to connect to; defaults to 11211. + +emailpost +--------- + +For post-by-email. + +enabled: Whether to enable post-by-email. Defaults to true. You will + also need to set up maildaemon.php. + +sms +--- + +For SMS integration. + +enabled: Whether to enable SMS integration. Defaults to true. Queues + should also be enabled. + +integration +----------- + +A catch-all for integration with other systems. + +taguri: base for tag:// URIs. Defaults to site-server + ',2009'. + +inboxes +------- + +For notice inboxes. + +enabled: No longer used. If you set this to something other than true, + StatusNet will no longer run. + +throttle +-------- + +For notice-posting throttles. + +enabled: Whether to throttle posting. Defaults to false. +count: Each user can make this many posts in 'timespan' seconds. So, if count + is 100 and timespan is 3600, then there can be only 100 posts + from a user every hour. +timespan: see 'count'. + +profile +------- + +Profile management. + +biolimit: max character length of bio; 0 means no limit; null means to use + the site text limit default. +backup: whether users can backup their own profiles. Defaults to true. +restore: whether users can restore their profiles from backup files. Defaults + to true. +delete: whether users can delete their own accounts. Defaults to false. +move: whether users can move their accounts to another server. Defaults + to true. + +newuser +------- + +Options with new users. + +default: nickname of a user account to automatically subscribe new + users to. Typically this would be system account for e.g. + service updates or announcements. Users are able to unsub + if they want. Default is null; no auto subscribe. +welcome: nickname of a user account that sends welcome messages to new + users. Can be the same as 'default' account, although on + busy servers it may be a good idea to keep that one just for + 'urgent' messages. Default is null; no message. + +If either of these special user accounts are specified, the users should +be created before the configuration is updated. + +snapshot +-------- + +The software will, by default, send statistical snapshots about the +local installation to a stats server on the status.net Web site. This +data is used by the developers to prioritize development decisions. No +identifying data about users or organizations is collected. The data +is available to the public for review. Participating in this survey +helps StatusNet developers take your needs into account when updating +the software. + +run: string indicating when to run the statistics. Values can be 'web' + (run occasionally at Web time), 'cron' (run from a cron script), + or 'never' (don't ever run). If you set it to 'cron', remember to + schedule the script to run on a regular basis. +frequency: if run value is 'web', how often to report statistics. + Measured in Web hits; depends on how active your site is. + Default is 10000 -- that is, one report every 10000 Web hits, + on average. +reporturl: URL to post statistics to. Defaults to StatusNet developers' + report system, but if they go evil or disappear you may + need to update this to another value. Note: if you + don't want to report stats, it's much better to + set 'run' to 'never' than to set this value to something + nonsensical. + +attachments +----------- + +The software lets users upload files with their notices. You can configure +the types of accepted files by mime types and a trio of quota options: +per file, per user (total), per user per month. + +We suggest the use of the pecl file_info extension to handle mime type +detection. + +supported: an array of mime types you accept to store and distribute, + like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you + setup your server to properly recognize the types you want to + support. +uploads: false to disable uploading files with notices (true by default). +filecommand: The required MIME_Type library may need to use the 'file' + command. It tries the one in the Web server's path, but if + you're having problems with uploads, try setting this to the + correct value. Note: 'file' must accept '-b' and '-i' options. + +For quotas, be sure you've set the upload_max_filesize and post_max_size +in php.ini to be large enough to handle your upload. In httpd.conf +(if you're using apache), check that the LimitRequestBody directive isn't +set too low (it's optional, so it may not be there at all). + +file_quota: maximum size for a single file upload in bytes. A user can send + any amount of notices with attachments as long as each attachment + is smaller than file_quota. +user_quota: total size in bytes a user can store on this server. Each user + can store any number of files as long as their total size does + not exceed the user_quota. +monthly_quota: total size permitted in the current month. This is the total + size in bytes that a user can upload each month. +dir: directory accessible to the Web process where uploads should go. + Defaults to the 'file' subdirectory of the install directory, which + should be writeable by the Web user. +server: server name to use when creating URLs for uploaded files. + Defaults to null, meaning to use the default Web server. Using + a virtual server here can speed up Web performance. +path: URL path, relative to the server, to find files. Defaults to + main path + '/file/'. +ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to + guess based on other SSL settings. +filecommand: command to use for determining the type of a file. May be + skipped if fileinfo extension is installed. Defaults to + '/usr/bin/file'. +sslserver: if specified, this server will be used when creating HTTPS + URLs. Otherwise, the site SSL server will be used, with /file/ path. +sslpath: if this and the sslserver are specified, this path will be used + when creating HTTPS URLs. Otherwise, the attachments|path value + will be used. + +group +----- + +Options for group functionality. + +maxaliases: maximum number of aliases a group can have. Default 3. Set + to 0 or less to prevent aliases in a group. +desclimit: maximum number of characters to allow in group descriptions. + null (default) means to use the site-wide text limits. 0 + means no limit. +addtag: Whether to add a tag for the group nickname for every group post + (pre-1.0.x behaviour). Defaults to false. + +oembed +-------- + +oEmbed endpoint for multimedia attachments (links in posts). Will also +work as 'oohembed' for backwards compatibility. + +endpoint: oohembed endpoint using http://oohembed.com/ software. Defaults to + 'http://oohembed.com/oohembed/'. +order: Array of methods to check for OEmbed data. Methods include 'built-in' + (use a built-in function to simulate oEmbed for some sites), + 'well-known' (use well-known public oEmbed endpoints), + 'discovery' (discover using headers in HTML), 'service' (use + a third-party service, like oohembed or embed.ly. Default is + array('built-in', 'well-known', 'service', 'discovery'). Note that very + few sites implement oEmbed; 'discovery' is going to fail 99% of the + time. + +search +------ + +Some stuff for search. + +type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either + be 'fulltext' (default) or 'like'. The former is faster and more efficient + but requires the lame old MyISAM engine for MySQL. The latter + will work with InnoDB but could be miserably slow on large + systems. We'll probably add another type sometime in the future, + with our own indexing system (maybe like MediaWiki's). + +sessions +-------- + +Session handling. + +handle: boolean. Whether we should register our own PHP session-handling + code (using the database and memcache if enabled). Defaults to false. + Setting this to true makes some sense on large or multi-server + sites, but it probably won't hurt for smaller ones, either. +debug: whether to output debugging info for session storage. Can help + with weird session bugs, sometimes. Default false. + +background +---------- + +Users can upload backgrounds for their pages; this section defines +their use. + +server: the server to use for background. Using a separate (even + virtual) server for this can speed up load times. Default is + null; same as site server. +dir: directory to write backgrounds too. Default is '/background/' + subdir of install dir. +path: path to backgrounds. Default is sub-path of install path; note + that you may need to change this if you change site-path too. +sslserver: SSL server to use when page is HTTPS-encrypted. If + unspecified, site ssl server and so on will be used. +sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted. + +ping +---- + +Using the "XML-RPC Ping" method initiated by weblogs.com, the site can +notify third-party servers of updates. + +notify: an array of URLs for ping endpoints. Default is the empty + array (no notification). + +design +------ + +Default design (colors and background) for the site. Actual appearance +depends on the theme. Null values mean to use the theme defaults. + +backgroundcolor: Hex color of the site background. +contentcolor: Hex color of the content area background. +sidebarcolor: Hex color of the sidebar background. +textcolor: Hex color of all non-link text. +linkcolor: Hex color of all links. +backgroundimage: Image to use for the background. +disposition: Flags for whether or not to tile the background image. + +notice +------ + +Configuration options specific to notices. + +contentlimit: max length of the plain-text content of a notice. + Default is null, meaning to use the site-wide text limit. + 0 means no limit. +defaultscope: default scope for notices. If null, the default + scope depends on site/private. It's 1 if the site is private, + 0 otherwise. Set this value to override. + +message +------- + +Configuration options specific to messages. + +contentlimit: max length of the plain-text content of a message. + Default is null, meaning to use the site-wide text limit. + 0 means no limit. + +logincommand +------------ + +Configuration options for the login command. + +disabled: whether to enable this command. If enabled, users who send + the text 'login' to the site through any channel will + receive a link to login to the site automatically in return. + Possibly useful for users who primarily use an XMPP or SMS + interface and can't be bothered to remember their site + password. Note that the security implications of this are + pretty serious and have not been thoroughly tested. You + should enable it only after you've convinced yourself that + it is safe. Default is 'false'. + +singleuser +---------- + +If an installation has only one user, this can simplify a lot of the +interface. It also makes the user's profile the root URL. + +enabled: Whether to run in "single user mode". Default false. +nickname: nickname of the single user. If no nickname is specified, + the site owner account will be used (if present). + +robotstxt +--------- + +We put out a default robots.txt file to guide the processing of +Web crawlers. See http://www.robotstxt.org/ for more information +on the format of this file. + +crawldelay: if non-empty, this value is provided as the Crawl-Delay: + for the robots.txt file. see http://ur1.ca/l5a0 + for more information. Default is zero, no explicit delay. +disallow: Array of (virtual) directories to disallow. Default is 'main', + 'search', 'message', 'settings', 'admin'. Ignored when site + is private, in which case the entire site ('/') is disallowed. + +api +--- + +Options for the Twitter-like API. + +realm: HTTP Basic Auth realm (see http://tools.ietf.org/html/rfc2617 + for details). Some third-party tools like ping.fm want this to be + 'Identi.ca API', so set it to that if you want to. default = null, + meaning 'something based on the site name'. + +nofollow +-------- + +We optionally put 'rel="nofollow"' on some links in some pages. The +following configuration settings let you fine-tune how or when things +are nofollowed. See http://en.wikipedia.org/wiki/Nofollow for more +information on what 'nofollow' means. + +subscribers: whether to nofollow links to subscribers on the profile + and personal pages. Default is true. +members: links to members on the group page. Default true. +peopletag: links to people listed in the peopletag page. Default true. +external: external links in notices. One of three values: 'sometimes', + 'always', 'never'. If 'sometimes', then external links are not + nofollowed on profile, notice, and favorites page. Default is + 'sometimes'. + +url +--- + +Everybody loves URL shorteners. These are some options for fine-tuning +how and when the server shortens URLs. + +shortener: URL shortening service to use by default. Users can override + individually. 'ur1.ca' by default. +maxlength: If an URL is strictly longer than this limit, it will be + shortened. Note that the URL shortener service may return an + URL longer than this limit. Defaults to 25. Users can + override. If set to 0, all URLs will be shortened. +maxnoticelength: If a notice is strictly longer than this limit, all + URLs in the notice will be shortened. Users can override. + -1 means the text limit for notices. + +router +------ + +We use a router class for mapping URLs to code. This section controls +how that router works. + +cache: whether to cache the router in memcache (or another caching + mechanism). Defaults to true, but may be set to false for + developers (who might be actively adding pages, so won't want the + router cached) or others who see strange behavior. You're unlikely + to need this unless you're a developer. + +http +---- + +Settings for the HTTP client. + +ssl_cafile: location of the CA file for SSL. If not set, won't verify + SSL peers. Default unset. +curl: Use cURL for doing HTTP calls. You must + have the PHP curl extension installed for this to work. +proxy_host: Host to use for proxying HTTP requests. If unset, doesn't + do any HTTP proxy stuff. Default unset. +proxy_port: Port to use to connect to HTTP proxy host. Default null. +proxy_user: Username to use for authenticating to the HTTP proxy. Default null. +proxy_password: Password to use for authenticating to the HTTP proxy. Default null. +proxy_auth_scheme: Scheme to use for authenticating to the HTTP proxy. Default null. + +plugins +------- + +default: associative array mapping plugin name to array of arguments. To disable + a default plugin, unset its value in this array. +locale_path: path for finding plugin locale files. In the plugin's directory + by default. +server: Server to find static files for a plugin when the page is plain old HTTP. + Defaults to site/server (same as pages). Use this to move plugin CSS and + JS files to a CDN. +sslserver: Server to find static files for a plugin when the page is HTTPS. Defaults + to site/server (same as pages). Use this to move plugin CSS and JS files + to a CDN. +path: Path to the plugin files. defaults to site/path + '/plugins/'. Expects that + each plugin will have a subdirectory at plugins/NameOfPlugin. Change this + if you're using a CDN. +sslpath: Path to use on the SSL server. Same as plugins/path. diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000000..db7aba017f --- /dev/null +++ b/INSTALL @@ -0,0 +1,519 @@ +Prerequisites +============= + +The following software packages are *required* for this software to +run correctly. + +- PHP 5.2.3+. It may be possible to run this software on earlier + versions of PHP, but many of the functions used are only available + in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background + daemons on 64-bit platforms. PHP 5.3.x should work correctly in this + release, but problems with some plugins are possible. +- MySQL 5.x. The StatusNet database is stored, by default, in a MySQL + server. It has been primarily tested on 5.x servers, although it may + be possible to install on earlier (or later!) versions. The server + *must* support the MyISAM storage engine -- the default for most + MySQL servers -- *and* the InnoDB storage engine. +- A Web server. Preferably, you should have Apache 2.2.x with the + mod_rewrite extension installed and enabled. + +Your PHP installation must include the following PHP extensions: + +- Curl. This is for fetching files by HTTP. +- XMLWriter. This is for formatting XML and HTML output. +- MySQL. For accessing the database. +- GD. For scaling down avatar images. +- mbstring. For handling Unicode (UTF-8) encoded strings. + +For some functionality, you will also need the following extensions: + +- Memcache. A client for the memcached server, which caches database + information in volatile memory. This is important for adequate + performance on high-traffic sites. You will also need a memcached + server to store the data in. +- Mailparse. Efficient parsing of email requires this extension. + Submission by email or SMS-over-email uses this extension. +- Sphinx Search. A client for the sphinx server, an alternative + to MySQL or Postgresql fulltext search. You will also need a + Sphinx server to serve the search queries. +- bcmath or gmp. For Salmon signatures (part of OStatus). Needed + if you have OStatus configured. +- gettext. For multiple languages. Default on many PHP installs; + will be emulated if not present. + +You will almost definitely get 2-3 times better performance from your +site if you install a PHP bytecode cache/accelerator. Some well-known +examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer +is a proprietary accelerator installed on some hosting sites. + +External libraries +------------------ + +A number of external PHP libraries are used to provide basic +functionality and optional functionality for your system. For your +convenience, they are available in the "extlib" directory of this +package, and you do not have to download and install them. However, +you may want to keep them up-to-date with the latest upstream version, +and the URLs are listed here for your convenience. + +- DB_DataObject http://pear.php.net/package/DB_DataObject +- Validate http://pear.php.net/package/Validate +- OpenID from OpenIDEnabled (not the PEAR version!). We decided + to use the openidenabled.com version since it's more widely + implemented, and seems to be better supported. + http://openidenabled.com/php-openid/ +- PEAR DB. Although this is an older data access system (new + packages should probably use PHP DBO), the OpenID libraries + depend on PEAR DB so we use it here, too. DB_DataObject can + also use PEAR MDB2, which may give you better performance + but won't work with OpenID. + http://pear.php.net/package/DB +- OAuth.php from http://oauth.googlecode.com/svn/code/php/ +- markdown.php from http://michelf.com/projects/php-markdown/ +- PEAR Mail, for sending out mail notifications + http://pear.php.net/package/Mail +- PEAR Net_SMTP, if you use the SMTP factory for notifications + http://pear.php.net/package/Net_SMTP +- PEAR Net_Socket, if you use the SMTP factory for notifications + http://pear.php.net/package/Net_Socket +- XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP + library available for PHP. http://xmpphp.googlecode.com/. Note that + as of this writing the version of this library that is available in + the extlib directory is *significantly different* from the upstream + version (patches have been submitted). Upgrading to the upstream + version may render your StatusNet site unable to send or receive XMPP + messages. +- Facebook library. Used for the Facebook application. +- PEAR Validate is used for URL and email validation. +- Console_GetOpt for parsing command-line options. + predecessor to OStatus. +- HTTP_Request2, a library for making HTTP requests. +- PEAR Net_URL2 is an HTTP_Request2 dependency. + +A design goal of StatusNet is that the basic Web functionality should +work on even the most restrictive commercial hosting services. +However, additional functionality, such as receiving messages by +Jabber/GTalk, require that you be able to run long-running processes +on your account. In addition, posting by email or from SMS require +that you be able to install a mail filter in your mail server. + +Installation +============ + +Installing the basic StatusNet Web component is relatively easy, +especially if you've previously installed PHP/MySQL packages. + +1. Unpack the tarball you downloaded on your Web server. Usually a + command like this will work: + + tar zxf statusnet-0.9.9.tar.gz + + ...which will make a statusnet-0.9.9 subdirectory in your current + directory. (If you don't have shell access on your Web server, you + may have to unpack the tarball on your local computer and FTP the + files to the server.) + +2. Move the tarball to a directory of your choosing in your Web root + directory. Usually something like this will work: + + mv statusnet-0.9.9 /var/www/statusnet + + This will make your StatusNet instance available in the statusnet path of + your server, like "http://example.net/statusnet". "microblog" or + "statusnet" might also be good path names. If you know how to + configure virtual hosts on your web server, you can try setting up + "http://micro.example.net/" or the like. + +3. Make your target directory writeable by the Web server. + + chmod a+w /var/www/statusnet/ + + On some systems, this will probably work: + + chgrp www-data /var/www/statusnet/ + chmod g+w /var/www/statusnet/ + + If your Web server runs as another user besides "www-data", try + that user's default group instead. As a last resort, you can create + a new group like "statusnet" and add the Web server's user to the group. + +4. You should also take this moment to make your avatar, background, and + file subdirectories writeable by the Web server. An insecure way to do + this is: + + chmod a+w /var/www/statusnet/avatar + chmod a+w /var/www/statusnet/background + chmod a+w /var/www/statusnet/file + + You can also make the avatar, background, and file directories + writeable by the Web server group, as noted above. + +5. Create a database to hold your microblog data. Something like this + should work: + + mysqladmin -u "username" --password="password" create statusnet + + Note that StatusNet must have its own database; you can't share the + database with another program. You can name it whatever you want, + though. + + (If you don't have shell access to your server, you may need to use + a tool like PHPAdmin to create a database. Check your hosting + service's documentation for how to create a new MySQL database.) + +6. Create a new database account that StatusNet will use to access the + database. If you have shell access, this will probably work from the + MySQL shell: + + GRANT ALL on statusnet.* + TO 'statusnetuser'@'localhost' + IDENTIFIED BY 'statusnetpassword'; + + You should change 'statusnetuser' and 'statusnetpassword' to your preferred new + username and password. You may want to test logging in to MySQL as + this new user. + +7. In a browser, navigate to the StatusNet install script; something like: + + http://yourserver.example.com/statusnet/install.php + + Enter the database connection information and your site name. The + install program will configure your site and install the initial, + almost-empty database. + +8. You should now be able to navigate to your microblog's main directory + and see the "Public Timeline", which will be empty. If not, magic + has happened! You can now register a new user, post some notices, + edit your profile, etc. However, you may want to wait to do that stuff + if you think you can set up "fancy URLs" (see below), since some + URLs are stored in the database. + +Fancy URLs +---------- + +By default, StatusNet will use URLs that include the main PHP program's +name in them. For example, a user's home profile might be +found at: + + http://example.org/statusnet/index.php/statusnet/fred + +On certain systems that don't support this kind of syntax, they'll +look like this: + + http://example.org/statusnet/index.php?p=statusnet/fred + +It's possible to configure the software so it looks like this instead: + + http://example.org/statusnet/fred + +These "fancy URLs" are more readable and memorable for users. To use +fancy URLs, you must either have Apache 2.x with .htaccess enabled and +mod_rewrite enabled, -OR- know how to configure "url redirection" in +your server. + +1. Copy the htaccess.sample file to .htaccess in your StatusNet + directory. Note: if you have control of your server's httpd.conf or + similar configuration files, it can greatly improve performance to + import the .htaccess file into your conf file instead. If you're + not sure how to do it, you may save yourself a lot of headache by + just leaving the .htaccess file. + +2. Change the "RewriteBase" in the new .htaccess file to be the URL path + to your StatusNet installation on your server. Typically this will + be the path to your StatusNet directory relative to your Web root. + +3. Add or uncomment or change a line in your config.php file so it says: + + $config['site']['fancy'] = true; + +You should now be able to navigate to a "fancy" URL on your server, +like: + + http://example.net/statusnet/main/register + +If you changed your HTTP server configuration, you may need to restart +the server first. + +If it doesn't work, double-check that AllowOverride for the StatusNet +directory is 'All' in your Apache configuration file. This is usually +/etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu) +/etc/apache2/sites-available/default. See the Apache documentation for +.htaccess files for more details: + + http://httpd.apache.org/docs/2.2/howto/htaccess.html + +Also, check that mod_rewrite is installed and enabled: + + http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html + +Sphinx +------ + +To use a Sphinx server to search users and notices, you'll need to +enable the SphinxSearch plugin. Add to your config.php: + + addPlugin('SphinxSearch'); + $config['sphinx']['server'] = 'searchhost.local'; + +You also need to install, compile and enable the sphinx pecl extension for +php on the client side, which itself depends on the sphinx development files. + +See plugins/SphinxSearch/README for more details and server setup. + +SMS +--- + +StatusNet supports a cheap-and-dirty system for sending update messages +to mobile phones and for receiving updates from the mobile. Instead of +sending through the SMS network itself, which is costly and requires +buy-in from the wireless carriers, it simply piggybacks on the email +gateways that many carriers provide to their customers. So, SMS +configuration is essentially email configuration. + +Each user sends to a made-up email address, which they keep a secret. +Incoming email that is "From" the user's SMS email address, and "To" +the users' secret email address on the site's domain, will be +converted to a notice and stored in the DB. + +For this to work, there *must* be a domain or sub-domain for which all +(or most) incoming email can pass through the incoming mail filter. + +1. Run the SQL script carrier.sql in your StatusNet database. This will + usually work: + + mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql + + This will populate your database with a list of wireless carriers + that support email SMS gateways. + +2. Make sure the maildaemon.php file is executable: + + chmod +x scripts/maildaemon.php + + Note that "daemon" is kind of a misnomer here; the script is more + of a filter than a daemon. + +2. Edit /etc/aliases on your mail server and add the following line: + + *: /path/to/statusnet/scripts/maildaemon.php + +3. Run whatever code you need to to update your aliases database. For + many mail servers (Postfix, Exim, Sendmail), this should work: + + newaliases + + You may need to restart your mail server for the new database to + take effect. + +4. Set the following in your config.php file: + + $config['mail']['domain'] = 'yourdomain.example.net'; + +At this point, post-by-email and post-by-SMS-gateway should work. Note +that if your mail server is on a different computer from your email +server, you'll need to have a full installation of StatusNet, a working +config.php, and access to the StatusNet database from the mail server. + +XMPP +---- + +XMPP (eXtended Message and Presence Protocol, ) is the +instant-messenger protocol that drives Jabber and GTalk IM. You can +distribute messages via XMPP using the system below; however, you +need to run the XMPP incoming daemon to allow incoming messages as +well. + +1. You may want to strongly consider setting up your own XMPP server. + Ejabberd, OpenFire, and JabberD are all Open Source servers. + Jabber, Inc. provides a high-performance commercial server. + +2. You must register a Jabber ID (JID) with your new server. It helps + to choose a name like "update@example.com" or "notice" or something + similar. Alternately, your "update JID" can be registered on a + publicly-available XMPP service, like jabber.org or GTalk. + + StatusNet will not register the JID with your chosen XMPP server; + you need to do this manually, with an XMPP client like Gajim, + Telepathy, or Pidgin.im. + +3. Configure your site's XMPP variables, as described below in the + configuration section. + +On a default installation, your site can broadcast messages using +XMPP. Users won't be able to post messages using XMPP unless you've +got the XMPP daemon running. See 'Queues and daemons' below for how +to set that up. Also, once you have a sizable number of users, sending +a lot of SMS, OStatus, and XMPP messages whenever someone posts a message +can really slow down your site; it may cause posting to timeout. + +NOTE: stream_select(), a crucial function for network programming, is +broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't +work around this bug in StatusNet; current recommendation is to move +off of amd64 to another server. + +Public feed +----------- + +You can send *all* messages from your social networking site to a +third-party service using XMPP. This can be useful for providing +search, indexing, bridging, or other cool services. + +To configure a downstream site to receive your public stream, add +their "JID" (Jabber ID) to your config.php as follows: + + $config['xmpp']['public'][] = 'downstream@example.net'; + +(Don't miss those square brackets at the end.) Note that your XMPP +broadcasting must be configured as mentioned above. Although you can +send out messages at "Web time", high-volume sites should strongly +consider setting up queues and daemons. + +Queues and daemons +------------------ + +Some activities that StatusNet needs to do, like broadcast OStatus, SMS, +and XMPP messages, can be 'queued' and done by off-line bots instead. +For this to work, you must be able to run long-running offline +processes, either on your main Web server or on another server you +control. (Your other server will still need all the above +prerequisites, with the exception of Apache.) Installing on a separate +server is probably a good idea for high-volume sites. + +1. You'll need the "CLI" (command-line interface) version of PHP + installed on whatever server you use. + +2. If you're using a separate server for queues, install StatusNet + somewhere on the server. You don't need to worry about the + .htaccess file, but make sure that your config.php file is close + to, or identical to, your Web server's version. + +3. In your config.php files (both the Web server and the queues + server!), set the following variable: + + $config['queue']['enabled'] = true; + + You may also want to look at the 'daemon' section of this file for + more daemon options. Note that if you set the 'user' and/or 'group' + options, you'll need to create that user and/or group by hand. + They're not created automatically. + +4. On the queues server, run the command scripts/startdaemons.sh. + +This will run the queue handlers: + +* queuedaemon.php - polls for queued items for inbox processing and + pushing out to OStatus, SMS, XMPP, etc. +* xmppdaemon.php - listens for new XMPP messages from users and stores + them as notices in the database; also pulls queued XMPP output from + queuedaemon.php to push out to clients. + +These two daemons will automatically restart in most cases of failure +including memory leaks (if a memory_limit is set), but may still die +or behave oddly if they lose connections to the XMPP or queue servers. + +Additional daemons may be also started by this script for certain +plugins, such as the Twitter bridge. + +It may be a good idea to use a daemon-monitoring service, like 'monit', +to check their status and keep them running. + +All the daemons write their process IDs (pids) to /var/run/ by +default. This can be useful for starting, stopping, and monitoring the +daemons. + +Since version 0.8.0, it's now possible to use a STOMP server instead of +our kind of hacky home-grown DB-based queue solution. This is strongly +recommended for best response time, especially when using XMPP. + +See the "queues" config section below for how to configure to use STOMP. +As of this writing, the software has been tested with ActiveMQ 5.3. + +Themes +------ + +There are two themes shipped with this version of StatusNet: "identica", +which is what the Identi.ca site uses, and "default", which is a good +basis for other sites. + +As of right now, your ability to change the theme is site-wide; users +can't choose their own theme. Additionally, the only thing you can +change in the theme is CSS stylesheets and some image files; you can't +change the HTML output, like adding or removing menu items. + +You can choose a theme using the $config['site']['theme'] element in +the config.php file. See below for details. + +You can add your own theme by making a sub-directory of the 'theme' +subdirectory with the name of your theme. Each theme can have the +following files: + +display.css: a CSS2 file for "default" styling for all browsers. +ie6.css: a CSS2 file for override styling for fixing up Internet + Explorer 6. +ie7.css: a CSS2 file for override styling for fixing up Internet + Explorer 7. +logo.png: a logo image for the site. +default-avatar-profile.png: a 96x96 pixel image to use as the avatar for + users who don't upload their own. +default-avatar-stream.png: Ditto, but 48x48. For streams of notices. +default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions + listing on profile pages. + +You may want to start by copying the files from the default theme to +your own directory. + +NOTE: the HTML generated by StatusNet changed *radically* between +version 0.6.x and 0.7.x. Older themes will need signification +modification to use the new output format. + +Translation +----------- + +Translations in StatusNet use the gettext system . +Theoretically, you can add your own sub-directory to the locale/ +subdirectory to add a new language to your system. You'll need to +compile the ".po" files into ".mo" files, however. + +Contributions of translation information to StatusNet are very easy: +you can use the Web interface at translatewiki.net to add one +or a few or lots of new translations -- or even new languages. You can +also download more up-to-date .po files there, if you so desire. + +For info on helping with translations, see http://status.net/wiki/Translations + +Backups +------- + +There is no built-in system for doing backups in StatusNet. You can make +backups of a working StatusNet system by backing up the database and +the Web directory. To backup the database use mysqldump +and to backup the Web directory, try tar. + +Private +------- + +The administrator can set the "private" flag for a site so that it's +not visible to non-logged-in users. This might be useful for +workgroups who want to share a social networking site for project +management, but host it on a public server. + +Total privacy is not guaranteed or ensured. Also, privacy is +all-or-nothing for a site; you can't have some accounts or notices +private, and others public. The interaction of private sites +with OStatus is undefined. + +Access to file attachments can also be restricted to logged-in users only. +1. Add a directory outside the web root where your file uploads will be + stored. Usually a command like this will work: + + mkdir /var/www/statusnet-files + +2. Make the file uploads directory writeable by the web server. An + insecure way to do this is: + + chmod a+x /var/www/statusnet-files + +3. Tell StatusNet to use this directory for file uploads. Add a line + like this to your config.php: + + $config['attachments']['dir'] = '/var/www/statusnet-files'; diff --git a/PLUGINS.txt b/PLUGINS.txt new file mode 100644 index 0000000000..79533b96de --- /dev/null +++ b/PLUGINS.txt @@ -0,0 +1,44 @@ +Plugins +======= + +Beginning with the 0.7.x branch, StatusNet has supported a simple but +powerful plugin architecture. Important events in the code are named, +like 'StartNoticeSave', and other software can register interest +in those events. When the events happen, the other software is called +and has a choice of accepting or rejecting the events. + +In the simplest case, you can add a function to config.php and use the +Event::addHandler() function to hook an event: + + function AddGoogleLink($action) + { + $action->menuItem('http://www.google.com/', _('Google'), _('Search engine')); + return true; + } + + Event::addHandler('EndPrimaryNav', 'AddGoogleLink'); + +This adds a menu item to the end of the main navigation menu. You can +see the list of existing events, and parameters that handlers must +implement, in EVENTS.txt. + +The Plugin class in lib/plugin.php makes it easier to write more +complex plugins. Sub-classes can just create methods named +'onEventName', where 'EventName' is the name of the event (case +matters!). These methods will be automatically registered as event +handlers by the Plugin constructor (which you must call from your own +class's constructor). + +Several example plugins are included in the plugins/ directory. You +can enable a plugin with the following line in config.php: + + addPlugin('Example', array('param1' => 'value1', + 'param2' => 'value2')); + +This will look for and load files named 'ExamplePlugin.php' or +'Example/ExamplePlugin.php' either in the plugins/ directory (for +plugins that ship with StatusNet) or in the local/ directory (for +plugins you write yourself or that you get from somewhere else) or +local/plugins/. + +Plugins are documented in their own directories. diff --git a/README b/README index bba3b19869..ffc77fcbe5 100644 --- a/README +++ b/README @@ -118,1548 +118,6 @@ A full changelog is available at http://status.net/wiki/StatusNet_0.9.9. NOTE: The short-lived StatusNet 0.9.8 ("Letter Never Sent") did not adequately fix bug #3260 as originally thought; thus this new release. -Prerequisites -============= - -The following software packages are *required* for this software to -run correctly. - -- PHP 5.2.3+. It may be possible to run this software on earlier - versions of PHP, but many of the functions used are only available - in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background - daemons on 64-bit platforms. PHP 5.3.x should work correctly in this - release, but problems with some plugins are possible. -- MySQL 5.x. The StatusNet database is stored, by default, in a MySQL - server. It has been primarily tested on 5.x servers, although it may - be possible to install on earlier (or later!) versions. The server - *must* support the MyISAM storage engine -- the default for most - MySQL servers -- *and* the InnoDB storage engine. -- A Web server. Preferably, you should have Apache 2.2.x with the - mod_rewrite extension installed and enabled. - -Your PHP installation must include the following PHP extensions: - -- Curl. This is for fetching files by HTTP. -- XMLWriter. This is for formatting XML and HTML output. -- MySQL. For accessing the database. -- GD. For scaling down avatar images. -- mbstring. For handling Unicode (UTF-8) encoded strings. - -For some functionality, you will also need the following extensions: - -- Memcache. A client for the memcached server, which caches database - information in volatile memory. This is important for adequate - performance on high-traffic sites. You will also need a memcached - server to store the data in. -- Mailparse. Efficient parsing of email requires this extension. - Submission by email or SMS-over-email uses this extension. -- Sphinx Search. A client for the sphinx server, an alternative - to MySQL or Postgresql fulltext search. You will also need a - Sphinx server to serve the search queries. -- bcmath or gmp. For Salmon signatures (part of OStatus). Needed - if you have OStatus configured. -- gettext. For multiple languages. Default on many PHP installs; - will be emulated if not present. - -You will almost definitely get 2-3 times better performance from your -site if you install a PHP bytecode cache/accelerator. Some well-known -examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer -is a proprietary accelerator installed on some hosting sites. - -External libraries ------------------- - -A number of external PHP libraries are used to provide basic -functionality and optional functionality for your system. For your -convenience, they are available in the "extlib" directory of this -package, and you do not have to download and install them. However, -you may want to keep them up-to-date with the latest upstream version, -and the URLs are listed here for your convenience. - -- DB_DataObject http://pear.php.net/package/DB_DataObject -- Validate http://pear.php.net/package/Validate -- OpenID from OpenIDEnabled (not the PEAR version!). We decided - to use the openidenabled.com version since it's more widely - implemented, and seems to be better supported. - http://openidenabled.com/php-openid/ -- PEAR DB. Although this is an older data access system (new - packages should probably use PHP DBO), the OpenID libraries - depend on PEAR DB so we use it here, too. DB_DataObject can - also use PEAR MDB2, which may give you better performance - but won't work with OpenID. - http://pear.php.net/package/DB -- OAuth.php from http://oauth.googlecode.com/svn/code/php/ -- markdown.php from http://michelf.com/projects/php-markdown/ -- PEAR Mail, for sending out mail notifications - http://pear.php.net/package/Mail -- PEAR Net_SMTP, if you use the SMTP factory for notifications - http://pear.php.net/package/Net_SMTP -- PEAR Net_Socket, if you use the SMTP factory for notifications - http://pear.php.net/package/Net_Socket -- XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP - library available for PHP. http://xmpphp.googlecode.com/. Note that - as of this writing the version of this library that is available in - the extlib directory is *significantly different* from the upstream - version (patches have been submitted). Upgrading to the upstream - version may render your StatusNet site unable to send or receive XMPP - messages. -- Facebook library. Used for the Facebook application. -- PEAR Validate is used for URL and email validation. -- Console_GetOpt for parsing command-line options. - predecessor to OStatus. -- HTTP_Request2, a library for making HTTP requests. -- PEAR Net_URL2 is an HTTP_Request2 dependency. - -A design goal of StatusNet is that the basic Web functionality should -work on even the most restrictive commercial hosting services. -However, additional functionality, such as receiving messages by -Jabber/GTalk, require that you be able to run long-running processes -on your account. In addition, posting by email or from SMS require -that you be able to install a mail filter in your mail server. - -Installation -============ - -Installing the basic StatusNet Web component is relatively easy, -especially if you've previously installed PHP/MySQL packages. - -1. Unpack the tarball you downloaded on your Web server. Usually a - command like this will work: - - tar zxf statusnet-0.9.9.tar.gz - - ...which will make a statusnet-0.9.9 subdirectory in your current - directory. (If you don't have shell access on your Web server, you - may have to unpack the tarball on your local computer and FTP the - files to the server.) - -2. Move the tarball to a directory of your choosing in your Web root - directory. Usually something like this will work: - - mv statusnet-0.9.9 /var/www/statusnet - - This will make your StatusNet instance available in the statusnet path of - your server, like "http://example.net/statusnet". "microblog" or - "statusnet" might also be good path names. If you know how to - configure virtual hosts on your web server, you can try setting up - "http://micro.example.net/" or the like. - -3. Make your target directory writeable by the Web server. - - chmod a+w /var/www/statusnet/ - - On some systems, this will probably work: - - chgrp www-data /var/www/statusnet/ - chmod g+w /var/www/statusnet/ - - If your Web server runs as another user besides "www-data", try - that user's default group instead. As a last resort, you can create - a new group like "statusnet" and add the Web server's user to the group. - -4. You should also take this moment to make your avatar, background, and - file subdirectories writeable by the Web server. An insecure way to do - this is: - - chmod a+w /var/www/statusnet/avatar - chmod a+w /var/www/statusnet/background - chmod a+w /var/www/statusnet/file - - You can also make the avatar, background, and file directories - writeable by the Web server group, as noted above. - -5. Create a database to hold your microblog data. Something like this - should work: - - mysqladmin -u "username" --password="password" create statusnet - - Note that StatusNet must have its own database; you can't share the - database with another program. You can name it whatever you want, - though. - - (If you don't have shell access to your server, you may need to use - a tool like PHPAdmin to create a database. Check your hosting - service's documentation for how to create a new MySQL database.) - -6. Create a new database account that StatusNet will use to access the - database. If you have shell access, this will probably work from the - MySQL shell: - - GRANT ALL on statusnet.* - TO 'statusnetuser'@'localhost' - IDENTIFIED BY 'statusnetpassword'; - - You should change 'statusnetuser' and 'statusnetpassword' to your preferred new - username and password. You may want to test logging in to MySQL as - this new user. - -7. In a browser, navigate to the StatusNet install script; something like: - - http://yourserver.example.com/statusnet/install.php - - Enter the database connection information and your site name. The - install program will configure your site and install the initial, - almost-empty database. - -8. You should now be able to navigate to your microblog's main directory - and see the "Public Timeline", which will be empty. If not, magic - has happened! You can now register a new user, post some notices, - edit your profile, etc. However, you may want to wait to do that stuff - if you think you can set up "fancy URLs" (see below), since some - URLs are stored in the database. - -Fancy URLs ----------- - -By default, StatusNet will use URLs that include the main PHP program's -name in them. For example, a user's home profile might be -found at: - - http://example.org/statusnet/index.php/statusnet/fred - -On certain systems that don't support this kind of syntax, they'll -look like this: - - http://example.org/statusnet/index.php?p=statusnet/fred - -It's possible to configure the software so it looks like this instead: - - http://example.org/statusnet/fred - -These "fancy URLs" are more readable and memorable for users. To use -fancy URLs, you must either have Apache 2.x with .htaccess enabled and -mod_rewrite enabled, -OR- know how to configure "url redirection" in -your server. - -1. Copy the htaccess.sample file to .htaccess in your StatusNet - directory. Note: if you have control of your server's httpd.conf or - similar configuration files, it can greatly improve performance to - import the .htaccess file into your conf file instead. If you're - not sure how to do it, you may save yourself a lot of headache by - just leaving the .htaccess file. - -2. Change the "RewriteBase" in the new .htaccess file to be the URL path - to your StatusNet installation on your server. Typically this will - be the path to your StatusNet directory relative to your Web root. - -3. Add or uncomment or change a line in your config.php file so it says: - - $config['site']['fancy'] = true; - -You should now be able to navigate to a "fancy" URL on your server, -like: - - http://example.net/statusnet/main/register - -If you changed your HTTP server configuration, you may need to restart -the server first. - -If it doesn't work, double-check that AllowOverride for the StatusNet -directory is 'All' in your Apache configuration file. This is usually -/etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu) -/etc/apache2/sites-available/default. See the Apache documentation for -.htaccess files for more details: - - http://httpd.apache.org/docs/2.2/howto/htaccess.html - -Also, check that mod_rewrite is installed and enabled: - - http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html - -Sphinx ------- - -To use a Sphinx server to search users and notices, you'll need to -enable the SphinxSearch plugin. Add to your config.php: - - addPlugin('SphinxSearch'); - $config['sphinx']['server'] = 'searchhost.local'; - -You also need to install, compile and enable the sphinx pecl extension for -php on the client side, which itself depends on the sphinx development files. - -See plugins/SphinxSearch/README for more details and server setup. - -SMS ---- - -StatusNet supports a cheap-and-dirty system for sending update messages -to mobile phones and for receiving updates from the mobile. Instead of -sending through the SMS network itself, which is costly and requires -buy-in from the wireless carriers, it simply piggybacks on the email -gateways that many carriers provide to their customers. So, SMS -configuration is essentially email configuration. - -Each user sends to a made-up email address, which they keep a secret. -Incoming email that is "From" the user's SMS email address, and "To" -the users' secret email address on the site's domain, will be -converted to a notice and stored in the DB. - -For this to work, there *must* be a domain or sub-domain for which all -(or most) incoming email can pass through the incoming mail filter. - -1. Run the SQL script carrier.sql in your StatusNet database. This will - usually work: - - mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql - - This will populate your database with a list of wireless carriers - that support email SMS gateways. - -2. Make sure the maildaemon.php file is executable: - - chmod +x scripts/maildaemon.php - - Note that "daemon" is kind of a misnomer here; the script is more - of a filter than a daemon. - -2. Edit /etc/aliases on your mail server and add the following line: - - *: /path/to/statusnet/scripts/maildaemon.php - -3. Run whatever code you need to to update your aliases database. For - many mail servers (Postfix, Exim, Sendmail), this should work: - - newaliases - - You may need to restart your mail server for the new database to - take effect. - -4. Set the following in your config.php file: - - $config['mail']['domain'] = 'yourdomain.example.net'; - -At this point, post-by-email and post-by-SMS-gateway should work. Note -that if your mail server is on a different computer from your email -server, you'll need to have a full installation of StatusNet, a working -config.php, and access to the StatusNet database from the mail server. - -XMPP ----- - -XMPP (eXtended Message and Presence Protocol, ) is the -instant-messenger protocol that drives Jabber and GTalk IM. You can -distribute messages via XMPP using the system below; however, you -need to run the XMPP incoming daemon to allow incoming messages as -well. - -1. You may want to strongly consider setting up your own XMPP server. - Ejabberd, OpenFire, and JabberD are all Open Source servers. - Jabber, Inc. provides a high-performance commercial server. - -2. You must register a Jabber ID (JID) with your new server. It helps - to choose a name like "update@example.com" or "notice" or something - similar. Alternately, your "update JID" can be registered on a - publicly-available XMPP service, like jabber.org or GTalk. - - StatusNet will not register the JID with your chosen XMPP server; - you need to do this manually, with an XMPP client like Gajim, - Telepathy, or Pidgin.im. - -3. Configure your site's XMPP variables, as described below in the - configuration section. - -On a default installation, your site can broadcast messages using -XMPP. Users won't be able to post messages using XMPP unless you've -got the XMPP daemon running. See 'Queues and daemons' below for how -to set that up. Also, once you have a sizable number of users, sending -a lot of SMS, OStatus, and XMPP messages whenever someone posts a message -can really slow down your site; it may cause posting to timeout. - -NOTE: stream_select(), a crucial function for network programming, is -broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't -work around this bug in StatusNet; current recommendation is to move -off of amd64 to another server. - -Public feed ------------ - -You can send *all* messages from your social networking site to a -third-party service using XMPP. This can be useful for providing -search, indexing, bridging, or other cool services. - -To configure a downstream site to receive your public stream, add -their "JID" (Jabber ID) to your config.php as follows: - - $config['xmpp']['public'][] = 'downstream@example.net'; - -(Don't miss those square brackets at the end.) Note that your XMPP -broadcasting must be configured as mentioned above. Although you can -send out messages at "Web time", high-volume sites should strongly -consider setting up queues and daemons. - -Queues and daemons ------------------- - -Some activities that StatusNet needs to do, like broadcast OStatus, SMS, -and XMPP messages, can be 'queued' and done by off-line bots instead. -For this to work, you must be able to run long-running offline -processes, either on your main Web server or on another server you -control. (Your other server will still need all the above -prerequisites, with the exception of Apache.) Installing on a separate -server is probably a good idea for high-volume sites. - -1. You'll need the "CLI" (command-line interface) version of PHP - installed on whatever server you use. - -2. If you're using a separate server for queues, install StatusNet - somewhere on the server. You don't need to worry about the - .htaccess file, but make sure that your config.php file is close - to, or identical to, your Web server's version. - -3. In your config.php files (both the Web server and the queues - server!), set the following variable: - - $config['queue']['enabled'] = true; - - You may also want to look at the 'daemon' section of this file for - more daemon options. Note that if you set the 'user' and/or 'group' - options, you'll need to create that user and/or group by hand. - They're not created automatically. - -4. On the queues server, run the command scripts/startdaemons.sh. - -This will run the queue handlers: - -* queuedaemon.php - polls for queued items for inbox processing and - pushing out to OStatus, SMS, XMPP, etc. -* xmppdaemon.php - listens for new XMPP messages from users and stores - them as notices in the database; also pulls queued XMPP output from - queuedaemon.php to push out to clients. - -These two daemons will automatically restart in most cases of failure -including memory leaks (if a memory_limit is set), but may still die -or behave oddly if they lose connections to the XMPP or queue servers. - -Additional daemons may be also started by this script for certain -plugins, such as the Twitter bridge. - -It may be a good idea to use a daemon-monitoring service, like 'monit', -to check their status and keep them running. - -All the daemons write their process IDs (pids) to /var/run/ by -default. This can be useful for starting, stopping, and monitoring the -daemons. - -Since version 0.8.0, it's now possible to use a STOMP server instead of -our kind of hacky home-grown DB-based queue solution. This is strongly -recommended for best response time, especially when using XMPP. - -See the "queues" config section below for how to configure to use STOMP. -As of this writing, the software has been tested with ActiveMQ 5.3. - -Themes ------- - -There are two themes shipped with this version of StatusNet: "identica", -which is what the Identi.ca site uses, and "default", which is a good -basis for other sites. - -As of right now, your ability to change the theme is site-wide; users -can't choose their own theme. Additionally, the only thing you can -change in the theme is CSS stylesheets and some image files; you can't -change the HTML output, like adding or removing menu items. - -You can choose a theme using the $config['site']['theme'] element in -the config.php file. See below for details. - -You can add your own theme by making a sub-directory of the 'theme' -subdirectory with the name of your theme. Each theme can have the -following files: - -display.css: a CSS2 file for "default" styling for all browsers. -ie6.css: a CSS2 file for override styling for fixing up Internet - Explorer 6. -ie7.css: a CSS2 file for override styling for fixing up Internet - Explorer 7. -logo.png: a logo image for the site. -default-avatar-profile.png: a 96x96 pixel image to use as the avatar for - users who don't upload their own. -default-avatar-stream.png: Ditto, but 48x48. For streams of notices. -default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions - listing on profile pages. - -You may want to start by copying the files from the default theme to -your own directory. - -NOTE: the HTML generated by StatusNet changed *radically* between -version 0.6.x and 0.7.x. Older themes will need signification -modification to use the new output format. - -Translation ------------ - -Translations in StatusNet use the gettext system . -Theoretically, you can add your own sub-directory to the locale/ -subdirectory to add a new language to your system. You'll need to -compile the ".po" files into ".mo" files, however. - -Contributions of translation information to StatusNet are very easy: -you can use the Web interface at translatewiki.net to add one -or a few or lots of new translations -- or even new languages. You can -also download more up-to-date .po files there, if you so desire. - -For info on helping with translations, see http://status.net/wiki/Translations - -Backups -------- - -There is no built-in system for doing backups in StatusNet. You can make -backups of a working StatusNet system by backing up the database and -the Web directory. To backup the database use mysqldump -and to backup the Web directory, try tar. - -Private -------- - -The administrator can set the "private" flag for a site so that it's -not visible to non-logged-in users. This might be useful for -workgroups who want to share a social networking site for project -management, but host it on a public server. - -Total privacy is not guaranteed or ensured. Also, privacy is -all-or-nothing for a site; you can't have some accounts or notices -private, and others public. The interaction of private sites -with OStatus is undefined. - -Access to file attachments can also be restricted to logged-in users only. -1. Add a directory outside the web root where your file uploads will be - stored. Usually a command like this will work: - - mkdir /var/www/statusnet-files - -2. Make the file uploads directory writeable by the web server. An - insecure way to do this is: - - chmod a+x /var/www/statusnet-files - -3. Tell StatusNet to use this directory for file uploads. Add a line - like this to your config.php: - - $config['attachments']['dir'] = '/var/www/statusnet-files'; - -Upgrading -========= - -IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some -incorrectly-stored international characters ("UTF-8"). For new -installations, it will now store non-ASCII characters correctly. -However, older installations will have the incorrect storage, and will -consequently show up "wrong" in browsers. See below for how to deal -with this situation. - -If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've -been tracking the "git" version of the software, you will probably -want to upgrade and keep your existing data. There is no automated -upgrade procedure in StatusNet 0.9.9. Try these step-by-step -instructions; read to the end first before trying them. - -0. Download StatusNet and set up all the prerequisites as if you were - doing a new install. -1. Make backups of both your database and your Web directory. UNDER NO - CIRCUMSTANCES should you try to do an upgrade without a known-good - backup. You have been warned. -2. Shut down Web access to your site, either by turning off your Web - server or by redirecting all pages to a "sorry, under maintenance" - page. -3. Shut down XMPP access to your site, typically by shutting down the - xmppdaemon.php process and all other daemons that you're running. - If you've got "monit" or "cron" automatically restarting your - daemons, make sure to turn that off, too. -4. Shut down SMS and email access to your site. The easy way to do - this is to comment out the line piping incoming email to your - maildaemon.php file, and running something like "newaliases". -5. Once all writing processes to your site are turned off, make a - final backup of the Web directory and database. -6. Move your StatusNet directory to a backup spot, like "statusnet.bak". -7. Unpack your StatusNet 0.9.9 tarball and move it to "statusnet" or - wherever your code used to be. -8. Copy the config.php file and the contents of the avatar/, background/, - file/, and local/ subdirectories from your old directory to your new - directory. -9. Copy htaccess.sample to .htaccess in the new directory. Change the - RewriteBase to use the correct path. -10. Rebuild the database. - - NOTE: this step is destructive and cannot be - reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't - do it without a known-good backup! - - If your database is at version 0.8.0 or higher in the 0.8.x line, you can run a - special upgrade script: - - mysql -u -p db/08to09.sql - - If you are upgrading from any 0.9.x version like 0.9.6, run this script: - - mysql -u -p db/096to097.sql - - Despite the name, it should work for any 0.9.x branch. - - Otherwise, go to your StatusNet directory and AFTER YOU MAKE A - BACKUP run the rebuilddb.sh script like this: - - ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql - - Here, rootuser and rootpassword are the username and password for a - user who can drop and create databases as well as tables; typically - that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops - your database and rebuilds it; if there is an error you have no - database. Make sure you have a backup. - For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh, - which operates slightly differently. Read the documentation in that - script before running it. -11. Use mysql or psql client to log into your database and make sure that - the notice, user, profile, subscription etc. tables are non-empty. -12. Turn back on the Web server, and check that things still work. -13. Turn back on XMPP bots and email maildaemon. Note that the XMPP - bots have changed since version 0.5; see above for details. - -If you're upgrading from very old versions, you may want to look at -the fixup_* scripts in the scripts directories. These will store some -precooked data in the DB. All upgraders should check out the inboxes -options below. - -NOTE: the database definition file, laconica.ini, has been renamed to -statusnet.ini (since this is the recommended database name). If you -have a line in your config.php pointing to the old name, you'll need -to update it. - -NOTE: the 1.0.0 version of StatusNet changed the URLs for all admin -panels from /admin/* to /panel/*. This now allows the (popular) -username 'admin', but blocks the considerably less popular username -'panel'. If you have an existing user named 'panel', you should rename -them before upgrading. - -Notice inboxes --------------- - -Notice inboxes are now required. If you don't have inboxes enabled, -StatusNet will no longer run. - -UTF-8 Database --------------- - -StatusNet 0.7.4 introduced a fix for some incorrectly-stored -international characters ("UTF-8"). This fix is not -backwards-compatible; installations from before 0.7.4 will show -non-ASCII characters of old notices incorrectly. This section explains -what to do. - -0. You can disable the new behaviour by setting the 'db''utf8' config - option to "false". You should only do this until you're ready to - convert your DB to the new format. -1. When you're ready to convert, you can run the fixup_utf8.php script - in the scripts/ subdirectory. If you've had the "new behaviour" - enabled (probably a good idea), you can give the ID of the first - "new" notice as a parameter, and only notices before that one will - be converted. Notices are converted in reverse chronological order, - so the most recent (and visible) ones will be converted first. The - script should work whether or not you have the 'db''utf8' config - option enabled. -2. When you're ready, set $config['db']['utf8'] to true, so that - new notices will be stored correctly. - -Configuration options -===================== - -The main configuration file for StatusNet (excepting configurations for -dependency software) is config.php in your StatusNet directory. If you -edit any other file in the directory, like lib/default.php (where most -of the defaults are defined), you will lose your configuration options -in any upgrade, and you will wish that you had been more careful. - -Starting with version 0.9.0, a Web based configuration panel has been -added to StatusNet. The preferred method for changing config options is -to use this panel. - -A command-line script, setconfig.php, can be used to set individual -configuration options. It's in the scripts/ directory. - -Starting with version 0.7.1, you can put config files in the -/etc/statusnet/ directory on your server, if it exists. Config files -will be included in this order: - -* /etc/statusnet/statusnet.php - server-wide config -* /etc/statusnet/.php - for a virtual host -* /etc/statusnet/_.php - for a path -* INSTALLDIR/config.php - for a particular implementation - -Almost all configuration options are made through a two-dimensional -associative array, cleverly named $config. A typical configuration -line will be: - - $config['section']['option'] = value; - -For brevity, the following documentation describes each section and -option. - -site ----- - -This section is a catch-all for site-wide variables. - -name: the name of your site, like 'YourCompany Microblog'. -server: the server part of your site's URLs, like 'example.net'. -path: The path part of your site's URLs, like 'statusnet' or '' - (installed in root). -fancy: whether or not your site uses fancy URLs (see Fancy URLs - section above). Default is false. -logfile: full path to a file for StatusNet to save logging - information to. You may want to use this if you don't have - access to syslog. -logdebug: whether to log additional debug info like backtraces on - hard errors. Default false. -locale_path: full path to the directory for locale data. Unless you - store all your locale data in one place, you probably - don't need to use this. -language: default language for your site. Defaults to US English. - Note that this is overridden if a user is logged in and has - selected a different language. It is also overridden if the - user is NOT logged in, but their browser requests a different - langauge. Since pretty much everybody's browser requests a - language, that means that changing this setting has little or - no effect in practice. -languages: A list of languages supported on your site. Typically you'd - only change this if you wanted to disable support for one - or another language: - "unset($config['site']['languages']['de'])" will disable - support for German. -theme: Theme for your site (see Theme section). Two themes are - provided by default: 'default' and 'stoica' (the one used by - Identi.ca). It's appreciated if you don't use the 'stoica' theme - except as the basis for your own. -email: contact email address for your site. By default, it's extracted - from your Web server environment; you may want to customize it. -broughtbyurl: name of an organization or individual who provides the - service. Each page will include a link to this name in the - footer. A good way to link to the blog, forum, wiki, - corporate portal, or whoever is making the service available. -broughtby: text used for the "brought by" link. -timezone: default timezone for message display. Users can set their - own time zone. Defaults to 'UTC', which is a pretty good default. -closed: If set to 'true', will disallow registration on your site. - This is a cheap way to restrict accounts to only one - individual or group; just register the accounts you want on - the service, *then* set this variable to 'true'. -inviteonly: If set to 'true', will only allow registration if the user - was invited by an existing user. -private: If set to 'true', anonymous users will be redirected to the - 'login' page. Also, API methods that normally require no - authentication will require it. Note that this does not turn - off registration; use 'closed' or 'inviteonly' for the - behaviour you want. -notice: A plain string that will appear on every page. A good place - to put introductory information about your service, or info about - upgrades and outages, or other community info. Any HTML will - be escaped. -logo: URL of an image file to use as the logo for the site. Overrides - the logo in the theme, if any. -ssllogo: URL of an image file to use as the logo on SSL pages. If unset, - theme logo is used instead. -ssl: Whether to use SSL and https:// URLs for some or all pages. - Possible values are 'always' (use it for all pages), 'never' - (don't use it for any pages), or 'sometimes' (use it for - sensitive pages that include passwords like login and registration, - but not for regular pages). Default to 'never'. -sslserver: use an alternate server name for SSL URLs, like - 'secure.example.org'. You should be careful to set cookie - parameters correctly so that both the SSL server and the - "normal" server can access the session cookie and - preferably other cookies as well. -shorturllength: ignored. See 'url' section below. -dupelimit: minimum time allowed for one person to say the same thing - twice. Default 60s. Anything lower is considered a user - or UI error. -textlimit: default max size for texts in the site. Defaults to 0 (no limit). - Can be fine-tuned for notices, messages, profile bios and group descriptions. - -db --- - -This section is a reference to the configuration options for -DB_DataObject (see ). The ones that you may want to -set are listed below for clarity. - -database: a DSN (Data Source Name) for your StatusNet database. This is - in the format 'protocol://username:password@hostname/databasename', - where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you - really know what you're doing), 'username' is the username, - 'password' is the password, and etc. -ini_yourdbname: if your database is not named 'statusnet', you'll need - to set this to point to the location of the - statusnet.ini file. Note that the real name of your database - should go in there, not literally 'yourdbname'. -db_driver: You can try changing this to 'MDB2' to use the other driver - type for DB_DataObject, but note that it breaks the OpenID - libraries, which only support PEAR::DB. -debug: On a database error, you may get a message saying to set this - value to 5 to see debug messages in the browser. This breaks - just about all pages, and will also expose the username and - password -quote_identifiers: Set this to true if you're using postgresql. -type: either 'mysql' or 'postgresql' (used for some bits of - database-type-specific SQL in the code). Defaults to mysql. -mirror: you can set this to an array of DSNs, like the above - 'database' value. If it's set, certain read-only actions will - use a random value out of this array for the database, rather - than the one in 'database' (actually, 'database' is overwritten). - You can offload a busy DB server by setting up MySQL replication - and adding the slaves to this array. Note that if you want some - requests to go to the 'database' (master) server, you'll need - to include it in this array, too. -utf8: whether to talk to the database in UTF-8 mode. This is the default - with new installations, but older sites may want to turn it off - until they get their databases fixed up. See "UTF-8 database" - above for details. -schemacheck: when to let plugins check the database schema to add - tables or update them. Values can be 'runtime' (default) - or 'script'. 'runtime' can be costly (plugins check the - schema on every hit, adding potentially several db - queries, some quite long), but not everyone knows how to - run a script. If you can, set this to 'script' and run - scripts/checkschema.php whenever you install or upgrade a - plugin. - -syslog ------- - -By default, StatusNet sites log error messages to the syslog facility. -(You can override this using the 'logfile' parameter described above). - -appname: The name that StatusNet uses to log messages. By default it's - "statusnet", but if you have more than one installation on the - server, you may want to change the name for each instance so - you can track log messages more easily. -priority: level to log at. Currently ignored. -facility: what syslog facility to used. Defaults to LOG_USER, only - reset if you know what syslog is and have a good reason - to change it. - -queue ------ - -You can configure the software to queue time-consuming tasks, like -sending out SMS email or XMPP messages, for off-line processing. See -'Queues and daemons' above for how to set this up. - -enabled: Whether to uses queues. Defaults to false. -subsystem: Which kind of queueserver to use. Values include "db" for - our hacked-together database queuing (no other server - required) and "stomp" for a stomp server. -stomp_server: "broker URI" for stomp server. Something like - "tcp://hostname:61613". More complicated ones are - possible; see your stomp server's documentation for - details. -queue_basename: a root name to use for queues (stomp only). Typically - something like '/queue/sitename/' makes sense. If running - multiple instances on the same server, make sure that - either this setting or $config['site']['nickname'] are - unique for each site to keep them separate. - -stomp_username: username for connecting to the stomp server; defaults - to null. -stomp_password: password for connecting to the stomp server; defaults - to null. - -stomp_persistent: keep items across queue server restart, if enabled. - Under ActiveMQ, the server configuration determines if and how - persistent storage is actually saved. - - If using a message queue server other than ActiveMQ, you may - need to disable this if it does not support persistence. - -stomp_transactions: use transactions to aid in error detection. - A broken transaction will be seen quickly, allowing a message - to be redelivered immediately if a daemon crashes. - - If using a message queue server other than ActiveMQ, you may - need to disable this if it does not support transactions. - -stomp_acks: send acknowledgements to aid in flow control. - An acknowledgement of successful processing tells the server - we're ready for more and can help keep things moving smoothly. - - This should *not* be turned off when running with ActiveMQ, but - if using another message queue server that does not support - acknowledgements you might need to disable this. - -softlimit: an absolute or relative "soft memory limit"; daemons will - restart themselves gracefully when they find they've hit - this amount of memory usage. Defaults to 90% of PHP's global - memory_limit setting. - -inboxes: delivery of messages to receiver's inboxes can be delayed to - queue time for best interactive performance on the sender. - This may however be annoyingly slow when using the DB queues, - so you can set this to false if it's causing trouble. - -breakout: for stomp, individual queues are by default grouped up for - best scalability. If some need to be run by separate daemons, - etc they can be manually adjusted here. - - Default will share all queues for all sites within each group. - Specify as / or //, - using nickname identifier as site. - - 'main/distrib' separate "distrib" queue covering all sites - 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite' - -max_retries: for stomp, drop messages after N failed attempts to process. - Defaults to 10. - -dead_letter_dir: for stomp, optional directory to dump data on failed - queue processing events after discarding them. - -stomp_no_transactions: for stomp, the server does not support transactions, - so do not try to user them. This is needed for http://www.morbidq.com/. - -stomp_no_acks: for stomp, the server does not support acknowledgements. - so do not try to user them. This is needed for http://www.morbidq.com/. - -license -------- - -The default license to use for your users notices. The default is the -Creative Commons Attribution 3.0 license, which is probably the right -choice for any public site. Note that some other servers will not -accept notices if you apply a stricter license than this. - -type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved' - (default copyright), or 'private' (for private and confidential - information). -owner: for 'allrightsreserved' or 'private', an assigned copyright - holder (for example, an employer for a private site). If - not specified, will be attributed to 'contributors'. -url: URL of the license, used for links. -title: Title for the license, like 'Creative Commons Attribution 3.0'. -image: A button shown on each page for the license. - -mail ----- - -This is for configuring out-going email. We use PEAR's Mail module, -see: http://pear.php.net/manual/en/package.mail.mail.factory.php - -backend: the backend to use for mail, one of 'mail', 'sendmail', and - 'smtp'. Defaults to PEAR's default, 'mail'. -params: if the mail backend requires any parameters, you can provide - them in an associative array. - -nickname --------- - -This is for configuring nicknames in the service. - -blacklist: an array of strings for usernames that may not be - registered. A default array exists for strings that are - used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme') - but you may want to add others if you have other software - installed in a subdirectory of StatusNet or if you just - don't want certain words used as usernames. -featured: an array of nicknames of 'featured' users of the site. - Can be useful to draw attention to well-known users, or - interesting people, or whatever. - -avatar ------- - -For configuring avatar access. - -dir: Directory to look for avatar files and to put them into. - Defaults to avatar subdirectory of install directory; if - you change it, make sure to change path, too. -path: Path to avatars. Defaults to path for avatar subdirectory, - but you can change it if you wish. Note that this will - be included with the avatar server, too. -server: If set, defines another server where avatars are stored in the - root directory. Note that the 'avatar' subdir still has to be - writeable. You'd typically use this to split HTTP requests on - the client to speed up page loading, either with another - virtual server or with an NFS or SAMBA share. Clients - typically only make 2 connections to a single server at a - time , so this can parallelize the job. - Defaults to null. -ssl: Whether to access avatars using HTTPS. Defaults to null, meaning - to guess based on site-wide SSL settings. - -public ------- - -For configuring the public stream. - -localonly: If set to true, only messages posted by users of this - service (rather than other services, filtered through OStatus) - are shown in the public stream. Default true. -blacklist: An array of IDs of users to hide from the public stream. - Useful if you have someone making excessive Twitterfeed posts - to the site, other kinds of automated posts, testing bots, etc. -autosource: Sources of notices that are from automatic posters, and thus - should be kept off the public timeline. Default empty. - -theme ------ - -server: Like avatars, you can speed up page loading by pointing the - theme file lookup to another server (virtual or real). - Defaults to NULL, meaning to use the site server. -dir: Directory where theme files are stored. Used to determine - whether to show parts of a theme file. Defaults to the theme - subdirectory of the install directory. -path: Path part of theme URLs, before the theme name. Relative to the - theme server. It may make sense to change this path when upgrading, - (using version numbers as the path) to make sure that all files are - reloaded by caching clients or proxies. Defaults to null, - which means to use the site path + '/theme'. -ssl: Whether to use SSL for theme elements. Default is null, which means - guess based on site SSL settings. -sslserver: SSL server to use when page is HTTPS-encrypted. If - unspecified, site ssl server and so on will be used. -sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted. - -javascript ----------- - -server: You can speed up page loading by pointing the - theme file lookup to another server (virtual or real). - Defaults to NULL, meaning to use the site server. -path: Path part of Javascript URLs. Defaults to null, - which means to use the site path + '/js/'. -ssl: Whether to use SSL for JavaScript files. Default is null, which means - guess based on site SSL settings. -sslserver: SSL server to use when page is HTTPS-encrypted. If - unspecified, site ssl server and so on will be used. -sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted. -bustframes: If true, all web pages will break out of framesets. If false, - can comfortably live in a frame or iframe... probably. Default - to true. - -xmpp ----- - -For configuring the XMPP sub-system. - -enabled: Whether to accept and send messages by XMPP. Default false. -server: server part of XMPP ID for update user. -port: connection port for clients. Default 5222, which you probably - shouldn't need to change. -user: username for the client connection. Users will receive messages - from 'user'@'server'. -resource: a unique identifier for the connection to the server. This - is actually used as a prefix for each XMPP component in the system. -password: password for the user account. -host: some XMPP domains are served by machines with a different - hostname. (For example, @gmail.com GTalk users connect to - talk.google.com). Set this to the correct hostname if that's the - case with your server. -encryption: Whether to encrypt the connection between StatusNet and the - XMPP server. Defaults to true, but you can get - considerably better performance turning it off if you're - connecting to a server on the same machine or on a - protected network. -debug: if turned on, this will make the XMPP library blurt out all of - the incoming and outgoing messages as XML stanzas. Use as a - last resort, and never turn it on if you don't have queues - enabled, since it will spit out sensitive data to the browser. -public: an array of JIDs to send _all_ notices to. This is useful for - participating in third-party search and archiving services. - -invite ------- - -For configuring invites. - -enabled: Whether to allow users to send invites. Default true. - -tag ---- - -Miscellaneous tagging stuff. - -dropoff: Decay factor for tag listing, in seconds. - Defaults to exponential decay over ten days; you can twiddle - with it to try and get better results for your site. - -popular -------- - -Settings for the "popular" section of the site. - -dropoff: Decay factor for popularity listing, in seconds. - Defaults to exponential decay over ten days; you can twiddle - with it to try and get better results for your site. - -daemon ------- - -For daemon processes. - -piddir: directory that daemon processes should write their PID file - (process ID) to. Defaults to /var/run/, which is where this - stuff should usually go on Unix-ish systems. -user: If set, the daemons will try to change their effective user ID - to this user before running. Probably a good idea, especially if - you start the daemons as root. Note: user name, like 'daemon', - not 1001. -group: If set, the daemons will try to change their effective group ID - to this named group. Again, a name, not a numerical ID. - -memcached ---------- - -You can get a significant boost in performance by caching some -database data in memcached . - -enabled: Set to true to enable. Default false. -server: a string with the hostname of the memcached server. Can also - be an array of hostnames, if you've got more than one server. -base: memcached uses key-value pairs to store data. We build long, - funny-looking keys to make sure we don't have any conflicts. The - base of the key is usually a simplified version of the site name - (like "Identi.ca" => "identica"), but you can overwrite this if - you need to. You can safely ignore it if you only have one - StatusNet site using your memcached server. -port: Port to connect to; defaults to 11211. - -emailpost ---------- - -For post-by-email. - -enabled: Whether to enable post-by-email. Defaults to true. You will - also need to set up maildaemon.php. - -sms ---- - -For SMS integration. - -enabled: Whether to enable SMS integration. Defaults to true. Queues - should also be enabled. - -integration ------------ - -A catch-all for integration with other systems. - -taguri: base for tag:// URIs. Defaults to site-server + ',2009'. - -inboxes -------- - -For notice inboxes. - -enabled: No longer used. If you set this to something other than true, - StatusNet will no longer run. - -throttle --------- - -For notice-posting throttles. - -enabled: Whether to throttle posting. Defaults to false. -count: Each user can make this many posts in 'timespan' seconds. So, if count - is 100 and timespan is 3600, then there can be only 100 posts - from a user every hour. -timespan: see 'count'. - -profile -------- - -Profile management. - -biolimit: max character length of bio; 0 means no limit; null means to use - the site text limit default. -backup: whether users can backup their own profiles. Defaults to true. -restore: whether users can restore their profiles from backup files. Defaults - to true. -delete: whether users can delete their own accounts. Defaults to false. -move: whether users can move their accounts to another server. Defaults - to true. - -newuser -------- - -Options with new users. - -default: nickname of a user account to automatically subscribe new - users to. Typically this would be system account for e.g. - service updates or announcements. Users are able to unsub - if they want. Default is null; no auto subscribe. -welcome: nickname of a user account that sends welcome messages to new - users. Can be the same as 'default' account, although on - busy servers it may be a good idea to keep that one just for - 'urgent' messages. Default is null; no message. - -If either of these special user accounts are specified, the users should -be created before the configuration is updated. - -snapshot --------- - -The software will, by default, send statistical snapshots about the -local installation to a stats server on the status.net Web site. This -data is used by the developers to prioritize development decisions. No -identifying data about users or organizations is collected. The data -is available to the public for review. Participating in this survey -helps StatusNet developers take your needs into account when updating -the software. - -run: string indicating when to run the statistics. Values can be 'web' - (run occasionally at Web time), 'cron' (run from a cron script), - or 'never' (don't ever run). If you set it to 'cron', remember to - schedule the script to run on a regular basis. -frequency: if run value is 'web', how often to report statistics. - Measured in Web hits; depends on how active your site is. - Default is 10000 -- that is, one report every 10000 Web hits, - on average. -reporturl: URL to post statistics to. Defaults to StatusNet developers' - report system, but if they go evil or disappear you may - need to update this to another value. Note: if you - don't want to report stats, it's much better to - set 'run' to 'never' than to set this value to something - nonsensical. - -attachments ------------ - -The software lets users upload files with their notices. You can configure -the types of accepted files by mime types and a trio of quota options: -per file, per user (total), per user per month. - -We suggest the use of the pecl file_info extension to handle mime type -detection. - -supported: an array of mime types you accept to store and distribute, - like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you - setup your server to properly recognize the types you want to - support. -uploads: false to disable uploading files with notices (true by default). -filecommand: The required MIME_Type library may need to use the 'file' - command. It tries the one in the Web server's path, but if - you're having problems with uploads, try setting this to the - correct value. Note: 'file' must accept '-b' and '-i' options. - -For quotas, be sure you've set the upload_max_filesize and post_max_size -in php.ini to be large enough to handle your upload. In httpd.conf -(if you're using apache), check that the LimitRequestBody directive isn't -set too low (it's optional, so it may not be there at all). - -file_quota: maximum size for a single file upload in bytes. A user can send - any amount of notices with attachments as long as each attachment - is smaller than file_quota. -user_quota: total size in bytes a user can store on this server. Each user - can store any number of files as long as their total size does - not exceed the user_quota. -monthly_quota: total size permitted in the current month. This is the total - size in bytes that a user can upload each month. -dir: directory accessible to the Web process where uploads should go. - Defaults to the 'file' subdirectory of the install directory, which - should be writeable by the Web user. -server: server name to use when creating URLs for uploaded files. - Defaults to null, meaning to use the default Web server. Using - a virtual server here can speed up Web performance. -path: URL path, relative to the server, to find files. Defaults to - main path + '/file/'. -ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to - guess based on other SSL settings. -filecommand: command to use for determining the type of a file. May be - skipped if fileinfo extension is installed. Defaults to - '/usr/bin/file'. -sslserver: if specified, this server will be used when creating HTTPS - URLs. Otherwise, the site SSL server will be used, with /file/ path. -sslpath: if this and the sslserver are specified, this path will be used - when creating HTTPS URLs. Otherwise, the attachments|path value - will be used. - -group ------ - -Options for group functionality. - -maxaliases: maximum number of aliases a group can have. Default 3. Set - to 0 or less to prevent aliases in a group. -desclimit: maximum number of characters to allow in group descriptions. - null (default) means to use the site-wide text limits. 0 - means no limit. -addtag: Whether to add a tag for the group nickname for every group post - (pre-1.0.x behaviour). Defaults to false. - -oembed --------- - -oEmbed endpoint for multimedia attachments (links in posts). Will also -work as 'oohembed' for backwards compatibility. - -endpoint: oohembed endpoint using http://oohembed.com/ software. Defaults to - 'http://oohembed.com/oohembed/'. -order: Array of methods to check for OEmbed data. Methods include 'built-in' - (use a built-in function to simulate oEmbed for some sites), - 'well-known' (use well-known public oEmbed endpoints), - 'discovery' (discover using headers in HTML), 'service' (use - a third-party service, like oohembed or embed.ly. Default is - array('built-in', 'well-known', 'service', 'discovery'). Note that very - few sites implement oEmbed; 'discovery' is going to fail 99% of the - time. - -search ------- - -Some stuff for search. - -type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either - be 'fulltext' (default) or 'like'. The former is faster and more efficient - but requires the lame old MyISAM engine for MySQL. The latter - will work with InnoDB but could be miserably slow on large - systems. We'll probably add another type sometime in the future, - with our own indexing system (maybe like MediaWiki's). - -sessions --------- - -Session handling. - -handle: boolean. Whether we should register our own PHP session-handling - code (using the database and memcache if enabled). Defaults to false. - Setting this to true makes some sense on large or multi-server - sites, but it probably won't hurt for smaller ones, either. -debug: whether to output debugging info for session storage. Can help - with weird session bugs, sometimes. Default false. - -background ----------- - -Users can upload backgrounds for their pages; this section defines -their use. - -server: the server to use for background. Using a separate (even - virtual) server for this can speed up load times. Default is - null; same as site server. -dir: directory to write backgrounds too. Default is '/background/' - subdir of install dir. -path: path to backgrounds. Default is sub-path of install path; note - that you may need to change this if you change site-path too. -sslserver: SSL server to use when page is HTTPS-encrypted. If - unspecified, site ssl server and so on will be used. -sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted. - -ping ----- - -Using the "XML-RPC Ping" method initiated by weblogs.com, the site can -notify third-party servers of updates. - -notify: an array of URLs for ping endpoints. Default is the empty - array (no notification). - -design ------- - -Default design (colors and background) for the site. Actual appearance -depends on the theme. Null values mean to use the theme defaults. - -backgroundcolor: Hex color of the site background. -contentcolor: Hex color of the content area background. -sidebarcolor: Hex color of the sidebar background. -textcolor: Hex color of all non-link text. -linkcolor: Hex color of all links. -backgroundimage: Image to use for the background. -disposition: Flags for whether or not to tile the background image. - -notice ------- - -Configuration options specific to notices. - -contentlimit: max length of the plain-text content of a notice. - Default is null, meaning to use the site-wide text limit. - 0 means no limit. -defaultscope: default scope for notices. If null, the default - scope depends on site/private. It's 1 if the site is private, - 0 otherwise. Set this value to override. - -message -------- - -Configuration options specific to messages. - -contentlimit: max length of the plain-text content of a message. - Default is null, meaning to use the site-wide text limit. - 0 means no limit. - -logincommand ------------- - -Configuration options for the login command. - -disabled: whether to enable this command. If enabled, users who send - the text 'login' to the site through any channel will - receive a link to login to the site automatically in return. - Possibly useful for users who primarily use an XMPP or SMS - interface and can't be bothered to remember their site - password. Note that the security implications of this are - pretty serious and have not been thoroughly tested. You - should enable it only after you've convinced yourself that - it is safe. Default is 'false'. - -singleuser ----------- - -If an installation has only one user, this can simplify a lot of the -interface. It also makes the user's profile the root URL. - -enabled: Whether to run in "single user mode". Default false. -nickname: nickname of the single user. If no nickname is specified, - the site owner account will be used (if present). - -robotstxt ---------- - -We put out a default robots.txt file to guide the processing of -Web crawlers. See http://www.robotstxt.org/ for more information -on the format of this file. - -crawldelay: if non-empty, this value is provided as the Crawl-Delay: - for the robots.txt file. see http://ur1.ca/l5a0 - for more information. Default is zero, no explicit delay. -disallow: Array of (virtual) directories to disallow. Default is 'main', - 'search', 'message', 'settings', 'admin'. Ignored when site - is private, in which case the entire site ('/') is disallowed. - -api ---- - -Options for the Twitter-like API. - -realm: HTTP Basic Auth realm (see http://tools.ietf.org/html/rfc2617 - for details). Some third-party tools like ping.fm want this to be - 'Identi.ca API', so set it to that if you want to. default = null, - meaning 'something based on the site name'. - -nofollow --------- - -We optionally put 'rel="nofollow"' on some links in some pages. The -following configuration settings let you fine-tune how or when things -are nofollowed. See http://en.wikipedia.org/wiki/Nofollow for more -information on what 'nofollow' means. - -subscribers: whether to nofollow links to subscribers on the profile - and personal pages. Default is true. -members: links to members on the group page. Default true. -peopletag: links to people listed in the peopletag page. Default true. -external: external links in notices. One of three values: 'sometimes', - 'always', 'never'. If 'sometimes', then external links are not - nofollowed on profile, notice, and favorites page. Default is - 'sometimes'. - -url ---- - -Everybody loves URL shorteners. These are some options for fine-tuning -how and when the server shortens URLs. - -shortener: URL shortening service to use by default. Users can override - individually. 'ur1.ca' by default. -maxlength: If an URL is strictly longer than this limit, it will be - shortened. Note that the URL shortener service may return an - URL longer than this limit. Defaults to 25. Users can - override. If set to 0, all URLs will be shortened. -maxnoticelength: If a notice is strictly longer than this limit, all - URLs in the notice will be shortened. Users can override. - -1 means the text limit for notices. - -router ------- - -We use a router class for mapping URLs to code. This section controls -how that router works. - -cache: whether to cache the router in memcache (or another caching - mechanism). Defaults to true, but may be set to false for - developers (who might be actively adding pages, so won't want the - router cached) or others who see strange behavior. You're unlikely - to need this unless you're a developer. - -http ----- - -Settings for the HTTP client. - -ssl_cafile: location of the CA file for SSL. If not set, won't verify - SSL peers. Default unset. -curl: Use cURL for doing HTTP calls. You must - have the PHP curl extension installed for this to work. -proxy_host: Host to use for proxying HTTP requests. If unset, doesn't - do any HTTP proxy stuff. Default unset. -proxy_port: Port to use to connect to HTTP proxy host. Default null. -proxy_user: Username to use for authenticating to the HTTP proxy. Default null. -proxy_password: Password to use for authenticating to the HTTP proxy. Default null. -proxy_auth_scheme: Scheme to use for authenticating to the HTTP proxy. Default null. - -plugins -------- - -default: associative array mapping plugin name to array of arguments. To disable - a default plugin, unset its value in this array. -locale_path: path for finding plugin locale files. In the plugin's directory - by default. -server: Server to find static files for a plugin when the page is plain old HTTP. - Defaults to site/server (same as pages). Use this to move plugin CSS and - JS files to a CDN. -sslserver: Server to find static files for a plugin when the page is HTTPS. Defaults - to site/server (same as pages). Use this to move plugin CSS and JS files - to a CDN. -path: Path to the plugin files. defaults to site/path + '/plugins/'. Expects that - each plugin will have a subdirectory at plugins/NameOfPlugin. Change this - if you're using a CDN. -sslpath: Path to use on the SSL server. Same as plugins/path. - -Plugins -======= - -Beginning with the 0.7.x branch, StatusNet has supported a simple but -powerful plugin architecture. Important events in the code are named, -like 'StartNoticeSave', and other software can register interest -in those events. When the events happen, the other software is called -and has a choice of accepting or rejecting the events. - -In the simplest case, you can add a function to config.php and use the -Event::addHandler() function to hook an event: - - function AddGoogleLink($action) - { - $action->menuItem('http://www.google.com/', _('Google'), _('Search engine')); - return true; - } - - Event::addHandler('EndPrimaryNav', 'AddGoogleLink'); - -This adds a menu item to the end of the main navigation menu. You can -see the list of existing events, and parameters that handlers must -implement, in EVENTS.txt. - -The Plugin class in lib/plugin.php makes it easier to write more -complex plugins. Sub-classes can just create methods named -'onEventName', where 'EventName' is the name of the event (case -matters!). These methods will be automatically registered as event -handlers by the Plugin constructor (which you must call from your own -class's constructor). - -Several example plugins are included in the plugins/ directory. You -can enable a plugin with the following line in config.php: - - addPlugin('Example', array('param1' => 'value1', - 'param2' => 'value2')); - -This will look for and load files named 'ExamplePlugin.php' or -'Example/ExamplePlugin.php' either in the plugins/ directory (for -plugins that ship with StatusNet) or in the local/ directory (for -plugins you write yourself or that you get from somewhere else) or -local/plugins/. - -Plugins are documented in their own directories. - Troubleshooting =============== diff --git a/UPGRADE b/UPGRADE new file mode 100644 index 0000000000..71607ea1ee --- /dev/null +++ b/UPGRADE @@ -0,0 +1,121 @@ +Upgrading +========= + +IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some +incorrectly-stored international characters ("UTF-8"). For new +installations, it will now store non-ASCII characters correctly. +However, older installations will have the incorrect storage, and will +consequently show up "wrong" in browsers. See below for how to deal +with this situation. + +If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've +been tracking the "git" version of the software, you will probably +want to upgrade and keep your existing data. There is no automated +upgrade procedure in StatusNet 0.9.9. Try these step-by-step +instructions; read to the end first before trying them. + +0. Download StatusNet and set up all the prerequisites as if you were + doing a new install. +1. Make backups of both your database and your Web directory. UNDER NO + CIRCUMSTANCES should you try to do an upgrade without a known-good + backup. You have been warned. +2. Shut down Web access to your site, either by turning off your Web + server or by redirecting all pages to a "sorry, under maintenance" + page. +3. Shut down XMPP access to your site, typically by shutting down the + xmppdaemon.php process and all other daemons that you're running. + If you've got "monit" or "cron" automatically restarting your + daemons, make sure to turn that off, too. +4. Shut down SMS and email access to your site. The easy way to do + this is to comment out the line piping incoming email to your + maildaemon.php file, and running something like "newaliases". +5. Once all writing processes to your site are turned off, make a + final backup of the Web directory and database. +6. Move your StatusNet directory to a backup spot, like "statusnet.bak". +7. Unpack your StatusNet 0.9.9 tarball and move it to "statusnet" or + wherever your code used to be. +8. Copy the config.php file and the contents of the avatar/, background/, + file/, and local/ subdirectories from your old directory to your new + directory. +9. Copy htaccess.sample to .htaccess in the new directory. Change the + RewriteBase to use the correct path. +10. Rebuild the database. + + NOTE: this step is destructive and cannot be + reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't + do it without a known-good backup! + + If your database is at version 0.8.0 or higher in the 0.8.x line, you can run a + special upgrade script: + + mysql -u -p db/08to09.sql + + If you are upgrading from any 0.9.x version like 0.9.6, run this script: + + mysql -u -p db/096to097.sql + + Despite the name, it should work for any 0.9.x branch. + + Otherwise, go to your StatusNet directory and AFTER YOU MAKE A + BACKUP run the rebuilddb.sh script like this: + + ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql + + Here, rootuser and rootpassword are the username and password for a + user who can drop and create databases as well as tables; typically + that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops + your database and rebuilds it; if there is an error you have no + database. Make sure you have a backup. + For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh, + which operates slightly differently. Read the documentation in that + script before running it. +11. Use mysql or psql client to log into your database and make sure that + the notice, user, profile, subscription etc. tables are non-empty. +12. Turn back on the Web server, and check that things still work. +13. Turn back on XMPP bots and email maildaemon. Note that the XMPP + bots have changed since version 0.5; see above for details. + +If you're upgrading from very old versions, you may want to look at +the fixup_* scripts in the scripts directories. These will store some +precooked data in the DB. All upgraders should check out the inboxes +options below. + +NOTE: the database definition file, laconica.ini, has been renamed to +statusnet.ini (since this is the recommended database name). If you +have a line in your config.php pointing to the old name, you'll need +to update it. + +NOTE: the 1.0.0 version of StatusNet changed the URLs for all admin +panels from /admin/* to /panel/*. This now allows the (popular) +username 'admin', but blocks the considerably less popular username +'panel'. If you have an existing user named 'panel', you should rename +them before upgrading. + +Notice inboxes +-------------- + +Notice inboxes are now required. If you don't have inboxes enabled, +StatusNet will no longer run. + +UTF-8 Database +-------------- + +StatusNet 0.7.4 introduced a fix for some incorrectly-stored +international characters ("UTF-8"). This fix is not +backwards-compatible; installations from before 0.7.4 will show +non-ASCII characters of old notices incorrectly. This section explains +what to do. + +0. You can disable the new behaviour by setting the 'db''utf8' config + option to "false". You should only do this until you're ready to + convert your DB to the new format. +1. When you're ready to convert, you can run the fixup_utf8.php script + in the scripts/ subdirectory. If you've had the "new behaviour" + enabled (probably a good idea), you can give the ID of the first + "new" notice as a parameter, and only notices before that one will + be converted. Notices are converted in reverse chronological order, + so the most recent (and visible) ones will be converted first. The + script should work whether or not you have the 'db''utf8' config + option enabled. +2. When you're ready, set $config['db']['utf8'] to true, so that + new notices will be stored correctly. diff --git a/actions/accessadminpanel.php b/actions/accessadminpanel.php index 027c69c5e5..55fc349f25 100644 --- a/actions/accessadminpanel.php +++ b/actions/accessadminpanel.php @@ -187,9 +187,9 @@ class AccessAdminPanelForm extends AdminForm */ function formActions() { - // TRANS: Title for button to save access settings in site admin panel. - $title = _('Save access settings'); - // TRANS: Tooltip for button to save access settings in site admin panel. + // TRANS: Button title to save access settings in site admin panel. + $title = _('Save access settings.'); + // TRANS: Button text to save access settings in site admin panel. $this->out->submit('submit', _m('BUTTON', 'Save'), 'submit', null, $title); } } diff --git a/actions/apiconversation.php b/actions/apiconversation.php index fefb5b67a5..504787b9a2 100644 --- a/actions/apiconversation.php +++ b/actions/apiconversation.php @@ -4,7 +4,7 @@ * Copyright (C) 2011, StatusNet, Inc. * * Show a stream of notices in a particular conversation - * + * * PHP version 5 * * This program is free software: you can redistribute it and/or modify @@ -46,12 +46,11 @@ require_once INSTALLDIR . '/lib/apiauth.php'; * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0 * @link http://status.net/ */ - class ApiconversationAction extends ApiAuthAction { - protected $conversation = null; - protected $notices = null; - + protected $conversation = null; + protected $notices = null; + /** * For initializing members of the class. * @@ -59,35 +58,36 @@ class ApiconversationAction extends ApiAuthAction * * @return boolean true */ - function prepare($argarray) { parent::prepare($argarray); - + $convId = $this->trimmed('id'); - + if (empty($convId)) { - throw new ClientException(_m('no conversation id')); + // TRANS: Client exception thrown when no conversation ID is given. + throw new ClientException(_('No conversation ID.')); } - + $this->conversation = Conversation::staticGet('id', $convId); - + if (empty($this->conversation)) { - throw new ClientException(sprintf(_m('No conversation with id %d'), $convId), - 404); + // TRANS: Client exception thrown when referring to a non-existing conversation ID (%d). + throw new ClientException(sprintf(_('No conversation with ID %d.'), $convId), + 404); } - + $profile = Profile::current(); - + $stream = new ConversationNoticeStream($convId, $profile); - + $notice = $stream->getNotices(($this->page-1) * $this->count, $this->count, $this->since_id, $this->max_id); - + $this->notices = $notice->fetchAll(); - + return true; } @@ -98,17 +98,16 @@ class ApiconversationAction extends ApiAuthAction * * @return void */ - function handle($argarray=null) { $sitename = common_config('site', 'name'); - // TRANS: Timeline title for user and friends. %s is a user nickname. - $title = _("Conversation"); + // TRANS: Title for conversion timeline. + $title = _m('TITLE', 'Conversation'); $id = common_local_url('apiconversation', array('id' => $this->conversation->id, 'format' => $this->format)); $link = common_local_url('conversation', array('id' => $this->conversation->id)); $self = $id; - + switch($this->format) { case 'xml': $this->showXmlTimeline($this->notices); @@ -168,7 +167,6 @@ class ApiconversationAction extends ApiAuthAction * * @return boolean is read only action? */ - function isReadOnly($args) { if ($_SERVER['REQUEST_METHOD'] == 'GET' || @@ -202,7 +200,6 @@ class ApiconversationAction extends ApiAuthAction * * @return string etag http header */ - function etag() { if (!empty($this->notices) && (count($this->notices) > 0)) { @@ -220,7 +217,7 @@ class ApiconversationAction extends ApiAuthAction ) . '"'; } - + return null; } @@ -229,7 +226,6 @@ class ApiconversationAction extends ApiAuthAction * * @return boolean true if delete, else false */ - function requiresAuth() { if ($_SERVER['REQUEST_METHOD'] == 'GET' || @@ -239,4 +235,4 @@ class ApiconversationAction extends ApiAuthAction return true; } } -} \ No newline at end of file +} diff --git a/actions/apitimelinefriends.php b/actions/apitimelinefriends.php index e27d052652..591baccfcc 100644 --- a/actions/apitimelinefriends.php +++ b/actions/apitimelinefriends.php @@ -267,15 +267,14 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction break; case 'as': header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE); - $doc = new ActivityStreamJSONDocument($this->auth_user); - $doc->setTitle($title); - $doc->addLink($link,'alternate', 'text/html'); + $doc = new ActivityStreamJSONDocument($this->auth_user, $title); + $doc->addLink($link, 'alternate', 'text/html'); $doc->addItemsFromNotices($this->notices); $this->raw($doc->asString()); break; default: // TRANS: Client error displayed when coming across a non-supported API method. - $this->clientError(_('API method not found.'), $code = 404); + $this->clientError(_('API method not found.'), 404); break; } } diff --git a/actions/apitimelinepublic.php b/actions/apitimelinepublic.php index 47e253d5fd..b82e01aafe 100644 --- a/actions/apitimelinepublic.php +++ b/actions/apitimelinepublic.php @@ -258,14 +258,18 @@ class ApiTimelinePublicAction extends ApiPrivateAuthAction { $notices = array(); - $notice = Notice::publicStream( - ($this->page - 1) * $this->count, $this->count, $this->since_id, - $this->max_id - ); + $profile = ($this->auth_user) ? $this->auth_user->getProfile() : null; - while ($notice->fetch()) { - $notices[] = clone($notice); - } + $stream = new PublicNoticeStream($profile); + + $notice = $stream->getNotices(($this->page - 1) * $this->count, + $this->count, + $this->since_id, + $this->max_id); + + $notices = $notice->fetchAll(); + + NoticeList::prefill($notices); return $notices; } diff --git a/actions/deleteaccount.php b/actions/deleteaccount.php index 614519d474..8b80c6c6f2 100644 --- a/actions/deleteaccount.php +++ b/actions/deleteaccount.php @@ -320,6 +320,6 @@ class DeleteAccountForm extends Form 'submit', null, // TRANS: Button title for user account deletion. - _('Permanently delete your account')); + _('Permanently delete your account.')); } } diff --git a/actions/imsettings.php b/actions/imsettings.php index e809981a3f..809dbd2879 100644 --- a/actions/imsettings.php +++ b/actions/imsettings.php @@ -67,7 +67,7 @@ class ImsettingsAction extends SettingsAction // TRANS: [instant messages] is link text, "(%%doc.im%%)" is the link. // TRANS: the order and formatting of link text and link should remain unchanged. return _('You can send and receive notices through '. - 'instant messaging [instant messages](%%doc.im%%). '. + '[instant messaging](%%doc.im%%). '. 'Configure your addresses and settings below.'); } diff --git a/actions/joingroup.php b/actions/joingroup.php index bb7b835915..fa5968a2c4 100644 --- a/actions/joingroup.php +++ b/actions/joingroup.php @@ -131,6 +131,10 @@ class JoingroupAction extends Action try { $result = $cur->joinGroup($this->group); } catch (Exception $e) { + common_log(LOG_ERR, sprintf("Couldn't join user %s to group %s: '%s'", + $cur->nickname, + $this->group->nickname, + $e->getMessage())); // TRANS: Server error displayed when joining a group failed in the database. // TRANS: %1$s is the joining user's nickname, $2$s is the group nickname for which the join failed. $this->serverError(sprintf(_('Could not join user %1$s to group %2$s.'), diff --git a/actions/pathsadminpanel.php b/actions/pathsadminpanel.php index 83ab776a60..57f066bd22 100644 --- a/actions/pathsadminpanel.php +++ b/actions/pathsadminpanel.php @@ -462,7 +462,7 @@ class PathsAdminPanelForm extends AdminForm // TRANS: Button text to store form data in the Paths admin panel. $this->out->submit('save', _m('BUTTON','Save'), 'submit', // TRANS: Button title text to store form data in the Paths admin panel. - 'save', _('Save paths')); + 'save', _('Save path settings.')); } /** diff --git a/actions/peopletagsbyuser.php b/actions/peopletagsbyuser.php index 0d9bd50faa..dc3e50b9f2 100644 --- a/actions/peopletagsbyuser.php +++ b/actions/peopletagsbyuser.php @@ -213,7 +213,7 @@ class PeopletagsbyuserAction extends Action '(http://en.wikipedia.org/wiki/Micro-blogging) service ' . 'based on the Free Software [StatusNet](http://status.net/) tool. ' . 'You can easily keep track of what they ' . - 'are doing by subscribing to the tag\'s timeline.' ), $this->tagger->nickname); + 'are doing by subscribing to the list\'s timeline.' ), $this->tagger->nickname); $this->elementStart('div', array('id' => 'anon_notice')); $this->raw(common_markup_to_html($notice)); $this->elementEnd('div'); diff --git a/actions/peopletagsforuser.php b/actions/peopletagsforuser.php index cc28133940..321dbe19a1 100644 --- a/actions/peopletagsforuser.php +++ b/actions/peopletagsforuser.php @@ -111,7 +111,7 @@ class PeopletagsforuserAction extends Action '(http://en.wikipedia.org/wiki/Micro-blogging) service ' . 'based on the Free Software [StatusNet](http://status.net/) tool. ' . 'You can easily keep track of what they ' . - 'are doing by subscribing to the tag\'s timeline.' ), $this->tagged->nickname); + 'are doing by subscribing to the list\'s timeline.' ), $this->tagged->nickname); $this->elementStart('div', array('id' => 'anon_notice')); $this->raw(common_markup_to_html($notice)); $this->elementEnd('div'); diff --git a/actions/public.php b/actions/public.php index e4f98dacc3..f62d032ef8 100644 --- a/actions/public.php +++ b/actions/public.php @@ -95,7 +95,7 @@ class PublicAction extends Action if (!$this->notice) { // TRANS: Server error displayed when a public timeline cannot be retrieved. - $this->serverError(_('Could not retrieve public stream.')); + $this->serverError(_('Could not retrieve public timeline.')); return; } @@ -166,20 +166,20 @@ class PublicAction extends Action common_local_url('ApiTimelinePublic', array('format' => 'as')), // TRANS: Link description for public timeline feed. - _('Public Stream Feed (Activity Streams JSON)')), + _('Public Timeline Feed (Activity Streams JSON)')), new Feed(Feed::RSS1, common_local_url('publicrss'), // TRANS: Link description for public timeline feed. - _('Public Stream Feed (RSS 1.0)')), + _('Public Timeline Feed (RSS 1.0)')), new Feed(Feed::RSS2, common_local_url('ApiTimelinePublic', array('format' => 'rss')), // TRANS: Link description for public timeline feed. - _('Public Stream Feed (RSS 2.0)')), + _('Public Timeline Feed (RSS 2.0)')), new Feed(Feed::ATOM, common_local_url('ApiTimelinePublic', array('format' => 'atom')), // TRANS: Link description for public timeline feed. - _('Public Stream Feed (Atom)'))); + _('Public Timeline Feed (Atom)'))); } function showEmptyList() diff --git a/actions/restoreaccount.php b/actions/restoreaccount.php index 22f0a8e5da..81c792bd00 100644 --- a/actions/restoreaccount.php +++ b/actions/restoreaccount.php @@ -339,7 +339,7 @@ class RestoreAccountForm extends Form $this->out->elementStart('p', 'instructions'); // TRANS: Form instructions for feed restore. - $this->out->raw(_('You can upload a backed-up stream in '. + $this->out->raw(_('You can upload a backed-up timeline in '. 'Activity Streams format.')); $this->out->elementEnd('p'); diff --git a/actions/showapplication.php b/actions/showapplication.php index f41c57643e..adfd17a06c 100644 --- a/actions/showapplication.php +++ b/actions/showapplication.php @@ -251,21 +251,24 @@ class ShowApplicationAction extends Action $this->elementStart('div', 'entity_data'); // TRANS: Header on the OAuth application page. $this->element('h2', null, _('Application info')); - $this->element('div', - 'entity_consumer_key', - $consumer->consumer_key); - $this->element('div', - 'entity_consumer_secret', - $consumer->consumer_secret); - - $this->element('div', - 'entity_request_token_url', - common_local_url('ApiOauthRequestToken')); - - $this->element('div', 'entity_access_token_url', common_local_url('ApiOauthAccessToken')); - - $this->element('div', 'entity_authorize_url', common_local_url('ApiOauthAuthorize')); + $this->elementStart('dl'); + // TRANS: Field label on application page. + $this->element('dt', null, _('Consumer key')); + $this->element('dd', null, $consumer->consumer_key); + // TRANS: Field label on application page. + $this->element('dt', null, _('Consumer secret')); + $this->element('dd', null, $consumer->consumer_secret); + // TRANS: Field label on application page. + $this->element('dt', null, _('Request token URL')); + $this->element('dd', null, common_local_url('ApiOauthRequestToken')); + // TRANS: Field label on application page. + $this->element('dt', null, _('Access token URL')); + $this->element('dd', null, common_local_url('ApiOauthAccessToken')); + // TRANS: Field label on application page. + $this->element('dt', null, _('Authorize URL')); + $this->element('dd', null, common_local_url('ApiOauthAuthorize')); + $this->elementEnd('dl'); $this->element('p', 'note', // TRANS: Note on the OAuth application page about signature support. diff --git a/actions/showstream.php b/actions/showstream.php index b4b7faf80a..ca7af0f2ed 100644 --- a/actions/showstream.php +++ b/actions/showstream.php @@ -65,11 +65,11 @@ class ShowstreamAction extends ProfileAction $base = $this->profile->getFancyName(); if (!empty($this->tag)) { if ($this->page == 1) { - // TRANS: Page title showing tagged notices in one user's stream. + // TRANS: Page title showing tagged notices in one user's timeline. // TRANS: %1$s is the username, %2$s is the hash tag. return sprintf(_('Notices by %1$s tagged %2$s'), $base, $this->tag); } else { - // TRANS: Page title showing tagged notices in one user's stream. + // TRANS: Page title showing tagged notices in one user's timeline. // TRANS: %1$s is the username, %2$s is the hash tag, %3$d is the page number. return sprintf(_('Notices by %1$s tagged %2$s, page %3$d'), $base, $this->tag, $this->page); } @@ -77,7 +77,7 @@ class ShowstreamAction extends ProfileAction if ($this->page == 1) { return $base; } else { - // TRANS: Extended page title showing tagged notices in one user's stream. + // TRANS: Extended page title showing tagged notices in one user's timeline. // TRANS: %1$s is the username, %2$d is the page number. return sprintf(_('Notices by %1$s, page %2$d'), $base, @@ -205,7 +205,7 @@ class ShowstreamAction extends ProfileAction function showEmptyListMessage() { - // TRANS: First sentence of empty list message for a stream. $1%s is a user nickname. + // TRANS: First sentence of empty list message for a timeline. $1%s is a user nickname. $message = sprintf(_('This is the timeline for %1$s, but %1$s hasn\'t posted anything yet.'), $this->user->nickname) . ' '; if (common_logged_in()) { @@ -214,7 +214,7 @@ class ShowstreamAction extends ProfileAction // TRANS: Second sentence of empty list message for a stream for the user themselves. $message .= _('Seen anything interesting recently? You haven\'t posted any notices yet, now would be a good time to start :)'); } else { - // TRANS: Second sentence of empty list message for a non-self stream. %1$s is a user nickname, %2$s is a part of a URL. + // TRANS: Second sentence of empty list message for a non-self timeline. %1$s is a user nickname, %2$s is a part of a URL. // TRANS: This message contains a Markdown link. Keep "](" together. $message .= sprintf(_('You can try to nudge %1$s or [post something to them](%%%%action.newnotice%%%%?status_textarea=%2$s).'), $this->user->nickname, '@' . $this->user->nickname); } @@ -257,14 +257,14 @@ class ShowstreamAction extends ProfileAction function showAnonymousMessage() { if (!(common_config('site','closed') || common_config('site','inviteonly'))) { - // TRANS: Announcement for anonymous users showing a stream if site registrations are open. + // TRANS: Announcement for anonymous users showing a timeline if site registrations are open. // TRANS: This message contains a Markdown link. Keep "](" together. $m = sprintf(_('**%s** has an account on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' . 'based on the Free Software [StatusNet](http://status.net/) tool. ' . '[Join now](%%%%action.register%%%%) to follow **%s**\'s notices and many more! ([Read more](%%%%doc.help%%%%))'), $this->user->nickname, $this->user->nickname); } else { - // TRANS: Announcement for anonymous users showing a stream if site registrations are closed or invite only. + // TRANS: Announcement for anonymous users showing a timeline if site registrations are closed or invite only. // TRANS: This message contains a Markdown link. Keep "](" together. $m = sprintf(_('**%s** has an account on %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' . 'based on the Free Software [StatusNet](http://status.net/) tool. '), diff --git a/actions/sitenoticeadminpanel.php b/actions/sitenoticeadminpanel.php index b1ac441af7..145ae80d07 100644 --- a/actions/sitenoticeadminpanel.php +++ b/actions/sitenoticeadminpanel.php @@ -197,7 +197,7 @@ class SiteNoticeAdminPanelForm extends AdminForm _m('BUTTON','Save'), 'submit', null, - // TRANS: Title for button to save site notice in admin panel. + // TRANS: Button title to save site notice in admin panel. _('Save site notice.') ); } diff --git a/actions/snapshotadminpanel.php b/actions/snapshotadminpanel.php index 9790947071..751b1acd1e 100644 --- a/actions/snapshotadminpanel.php +++ b/actions/snapshotadminpanel.php @@ -252,7 +252,7 @@ class SnapshotAdminPanelForm extends AdminForm _m('BUTTON','Save'), 'submit', null, - // TRANS: Title for button to save snapshot settings. + // TRANS: Button title to save snapshot settings. _('Save snapshot settings.') ); } diff --git a/actions/useradminpanel.php b/actions/useradminpanel.php index 19673189f5..1eda1c0c82 100644 --- a/actions/useradminpanel.php +++ b/actions/useradminpanel.php @@ -300,7 +300,7 @@ class UserAdminPanelForm extends AdminForm _m('BUTTON','Save'), 'submit', null, - // TRANS: Title for button to save user settings in user admin panel. + // TRANS: Button title to save user settings in user admin panel. _('Save user settings.')); } } diff --git a/actions/version.php b/actions/version.php index 37555652c7..a7b5fd8c72 100644 --- a/actions/version.php +++ b/actions/version.php @@ -1,7 +1,7 @@ * @author Craig Andrews - * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org + * @copyright 2009-2011 Free Software Foundation, Inc http://www.fsf.org * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3 * @link http://status.net/ */ @@ -149,7 +149,7 @@ class VersionAction extends Action // TRANS: Content part of StatusNet version page. // TRANS: %1$s is the engine name (StatusNet) and %2$s is the StatusNet version. $this->raw(sprintf(_('This site is powered by %1$s version %2$s, '. - 'Copyright 2008-2010 StatusNet, Inc. '. + 'Copyright 2008-2011 StatusNet, Inc. '. 'and contributors.'), XMLStringer::estring('a', array('href' => 'http://status.net/'), // TRANS: Engine name. @@ -160,6 +160,7 @@ class VersionAction extends Action // TRANS: Header for StatusNet contributors section on the version page. $this->element('h2', null, _('Contributors')); + sort($this->contributors); $this->element('p', null, implode(', ', $this->contributors)); // TRANS: Header for StatusNet license section on the version page. @@ -277,6 +278,7 @@ class VersionAction extends Action 'mEDI', 'Brett Taylor', 'Brigitte Schuster', - 'Brion Vibber', - 'Siebrand Mazeland'); + 'Brion Vibber (StatusNet)', + 'Siebrand Mazeland', + 'Samantha Doherty (StatusNet)'); } diff --git a/classes/Avatar.php b/classes/Avatar.php index bdf3739bbf..d871d360b6 100644 --- a/classes/Avatar.php +++ b/classes/Avatar.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Avatar extends Memcached_DataObject +class Avatar extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -32,6 +32,32 @@ class Avatar extends Memcached_DataObject return Memcached_DataObject::pivotGet('Avatar', $keyCol, $keyVals, $otherCols); } + public static function schemaDef() + { + return array( + 'fields' => array( + 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), + 'original' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'uploaded by user or generated?'), + 'width' => array('type' => 'int', 'not null' => true, 'description' => 'image width'), + 'height' => array('type' => 'int', 'not null' => true, 'description' => 'image height'), + 'mediatype' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'file type'), + 'filename' => array('type' => 'varchar', 'length' => 255, 'description' => 'local filename, if local'), + 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'avatar location'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('profile_id', 'width', 'height'), + 'unique keys' => array( + 'avatar_url_key' => array('url'), + ), + 'foreign keys' => array( + 'avatar_profile_id_fkey' => array('profile', array('profile_id' => 'id')), + ), + 'indexes' => array( + 'avatar_profile_id_idx' => array('profile_id'), + ), + ); + } // We clean up the file, too function delete() diff --git a/classes/Config.php b/classes/Config.php index e14730438e..ba0db588ca 100644 --- a/classes/Config.php +++ b/classes/Config.php @@ -27,7 +27,7 @@ if (!defined('STATUSNET')) { require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Config extends Memcached_DataObject +class Config extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -43,6 +43,18 @@ class Config extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'section' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'default' => '', 'description' => 'configuration section'), + 'setting' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'default' => '', 'description' => 'configuration setting'), + 'value' => array('type' => 'varchar', 'length' => 255, 'description' => 'configuration value'), + ), + 'primary key' => array('section', 'setting'), + ); + } + const settingsKey = 'config:settings'; static function loadSettings() diff --git a/classes/Confirm_address.php b/classes/Confirm_address.php index 4b9bec64c6..056df836fc 100644 --- a/classes/Confirm_address.php +++ b/classes/Confirm_address.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Confirm_address extends Memcached_DataObject +class Confirm_address extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -26,8 +26,25 @@ class Confirm_address extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE - function sequenceKey() - { return array(false, false); } + public static function schemaDef() + { + return array( + 'fields' => array( + 'code' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'good random code'), + 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who requested confirmation'), + 'address' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'address (email, xmpp, SMS, etc.)'), + 'address_extra' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'carrier ID, for SMS'), + 'address_type' => array('type' => 'varchar', 'length' => 8, 'not null' => true, 'description' => 'address type ("email", "xmpp", "sms")'), + 'claimed' => array('type' => 'datetime', 'description' => 'date this was claimed for queueing'), + 'sent' => array('type' => 'datetime', 'description' => 'date this was sent for queueing'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('code'), + 'foreign keys' => array( + 'confirm_address_user_id_fkey' => array('user', array('user_id' => 'id')), + ), + ); + } static function getAddress($address, $addressType) { diff --git a/classes/Consumer.php b/classes/Consumer.php index c1090b85a3..1d32d853bd 100644 --- a/classes/Consumer.php +++ b/classes/Consumer.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Consumer extends Memcached_DataObject +class Consumer extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -23,6 +23,22 @@ class Consumer extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'description' => 'OAuth consumer record', + 'fields' => array( + 'consumer_key' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'unique identifier, root URL'), + 'consumer_secret' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'secret value'), + 'seed' => array('type' => 'char', 'length' => 32, 'not null' => true, 'description' => 'seed for new tokens by this consumer'), + + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('consumer_key'), + ); + } + static function generateNew() { $cons = new Consumer(); diff --git a/classes/Conversation.php b/classes/Conversation.php index e029c20ba0..4bad474c73 100755 --- a/classes/Conversation.php +++ b/classes/Conversation.php @@ -29,7 +29,7 @@ require_once INSTALLDIR . '/classes/Memcached_DataObject.php'; -class Conversation extends Memcached_DataObject +class Conversation extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -46,6 +46,22 @@ class Conversation extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), + 'uri' => array('type' => 'varchar', 'length' => 225, 'description' => 'URI of the conversation'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('id'), + 'unique keys' => array( + 'conversation_uri_key' => array('uri'), + ), + ); + } + /** * Factory method for creating a new conversation * diff --git a/classes/Deleted_notice.php b/classes/Deleted_notice.php index 64dc85da65..d3f9c0bf7c 100644 --- a/classes/Deleted_notice.php +++ b/classes/Deleted_notice.php @@ -26,7 +26,7 @@ if (!defined('STATUSNET')) { */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Deleted_notice extends Memcached_DataObject +class Deleted_notice extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -43,4 +43,24 @@ class Deleted_notice extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'int', 'not null' => true, 'description' => 'identity of notice'), + 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'author of the notice'), + 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice record was created'), + 'deleted' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice record was created'), + ), + 'primary key' => array('id'), + 'unique keys' => array( + 'deleted_notice_uri_key' => array('uri'), + ), + 'indexes' => array( + 'deleted_notice_profile_id_idx' => array('profile_id'), + ), + ); + } } diff --git a/classes/Fave.php b/classes/Fave.php index 5067185c0e..467465ba05 100644 --- a/classes/Fave.php +++ b/classes/Fave.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Fave extends Memcached_DataObject +class Fave extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -12,6 +12,7 @@ class Fave extends Memcached_DataObject public $__table = 'fave'; // table name public $notice_id; // int(4) primary_key not_null public $user_id; // int(4) primary_key not_null + public $uri; // varchar(255) public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP /* Static get */ @@ -21,6 +22,31 @@ class Fave extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice that is the favorite'), + 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who likes this notice'), + 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('notice_id', 'user_id'), + 'unique keys' => array( + 'fave_uri_key' => array('uri'), + ), + 'foreign keys' => array( + 'fave_notice_id_fkey' => array('notice', array('notice_id' => 'id')), + 'fave_user_id_fkey' => array('profile', array('user_id' => 'id')), // note: formerly referenced notice.id, but we can now record remote users' favorites + ), + 'indexes' => array( + 'fave_notice_id_idx' => array('notice_id'), + 'fave_user_id_idx' => array('user_id', 'modified'), + 'fave_modified_idx' => array('modified'), + ), + ); + } + /** * Save a favorite record. * @fixme post-author notification should be moved here @@ -39,12 +65,15 @@ class Fave extends Memcached_DataObject $fave->user_id = $profile->id; $fave->notice_id = $notice->id; - + $fave->modified = common_sql_now(); + $fave->uri = self::newURI($fave->user_id, + $fave->notice_id, + $fave->modified); if (!$fave->insert()) { common_log_db_error($fave, 'INSERT', __FILE__); return false; } - self::blow('fave:list:notice_id:%d', $fave->notice_id); + self::blow('fave:list-ids:notice_id:%d', $fave->notice_id); Event::handle('EndFavorNotice', array($profile, $notice)); } @@ -62,7 +91,7 @@ class Fave extends Memcached_DataObject if (Event::handle('StartDisfavorNotice', array($profile, $notice, &$result))) { $result = parent::delete(); - self::blow('fave:list:notice_id:%d', $this->notice_id); + self::blow('fave:list-ids:notice_id:%d', $this->notice_id); if ($result) { Event::handle('EndDisfavorNotice', array($profile, $notice)); @@ -102,10 +131,7 @@ class Fave extends Memcached_DataObject // FIXME: rationalize this with URL below - $act->id = TagURI::mint('favor:%d:%d:%s', - $profile->id, - $notice->id, - common_date_iso8601($this->modified)); + $act->id = $this->getURI(); $act->time = strtotime($this->modified); // TRANS: Activity title when marking a notice as favorite. @@ -156,4 +182,21 @@ class Fave extends Memcached_DataObject return $fav; } + + function getURI() + { + if (!empty($this->uri)) { + return $this->uri; + } else { + return self::newURI($this->user_id, $this->notice_id, $this->modified); + } + } + + static function newURI($profile_id, $notice_id, $modified) + { + return TagURI::mint('favor:%d:%d:%s', + $profile_id, + $notice_id, + common_date_iso8601($modified)); + } } diff --git a/classes/File.php b/classes/File.php index 767a108087..f716a9d64c 100644 --- a/classes/File.php +++ b/classes/File.php @@ -29,7 +29,7 @@ require_once INSTALLDIR.'/classes/File_to_post.php'; /** * Table Definition for file */ -class File extends Memcached_DataObject +class File extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -51,6 +51,28 @@ class File extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'serial', 'not null' => true), + 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'destination URL after following redirections'), + 'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'), + 'size' => array('type' => 'int', 'description' => 'size of resource when available'), + 'title' => array('type' => 'varchar', 'length' => 255, 'description' => 'title of resource when available'), + 'date' => array('type' => 'int', 'description' => 'date of resource according to http query'), + 'protected' => array('type' => 'int', 'description' => 'true when URL is private (needs login)'), + 'filename' => array('type' => 'varchar', 'length' => 255, 'description' => 'if a local file, name of the file'), + + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('id'), + 'unique keys' => array( + 'file_url_key' => array('url'), + ), + ); + } + function isProtected($url) { return 'http://www.facebook.com/login.php' === $url; } diff --git a/classes/File_oembed.php b/classes/File_oembed.php index b7bf3a5dae..ae46e61bd4 100644 --- a/classes/File_oembed.php +++ b/classes/File_oembed.php @@ -26,7 +26,7 @@ require_once INSTALLDIR.'/classes/File_redirection.php'; * Table Definition for file_oembed */ -class File_oembed extends Memcached_DataObject +class File_oembed extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -53,9 +53,30 @@ class File_oembed extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE - function sequenceKey() + public static function schemaDef() { - return array(false, false, false); + return array( + 'fields' => array( + 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'oEmbed for that URL/file'), + 'version' => array('type' => 'varchar', 'length' => 20, 'description' => 'oEmbed spec. version'), + 'type' => array('type' => 'varchar', 'length' => 20, 'description' => 'oEmbed type: photo, video, link, rich'), + 'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'), + 'provider' => array('type' => 'varchar', 'length' => 50, 'description' => 'name of this oEmbed provider'), + 'provider_url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of this oEmbed provider'), + 'width' => array('type' => 'int', 'description' => 'width of oEmbed resource when available'), + 'height' => array('type' => 'int', 'description' => 'height of oEmbed resource when available'), + 'html' => array('type' => 'text', 'description' => 'html representation of this oEmbed resource when applicable'), + 'title' => array('type' => 'varchar', 'length' => 255, 'description' => 'title of oEmbed resource when available'), + 'author_name' => array('type' => 'varchar', 'length' => 50, 'description' => 'author name for this oEmbed resource'), + 'author_url' => array('type' => 'varchar', 'length' => 255, 'description' => 'author URL for this oEmbed resource'), + 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL for this oEmbed resource when applicable (photo, link)'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('file_id'), + 'foreign keys' => array( + 'file_oembed_file_id_fkey' => array('file', array('file_id' => 'id')), + ), + ); } function _getOembed($url) { diff --git a/classes/File_redirection.php b/classes/File_redirection.php index 74e89db5f2..130d9e7d74 100644 --- a/classes/File_redirection.php +++ b/classes/File_redirection.php @@ -27,7 +27,7 @@ require_once INSTALLDIR.'/classes/File_oembed.php'; * Table Definition for file_redirection */ -class File_redirection extends Memcached_DataObject +class File_redirection extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -45,6 +45,23 @@ class File_redirection extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'url' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'short URL (or any other kind of redirect) for file (id)'), + 'file_id' => array('type' => 'int', 'description' => 'short URL for what URL/file'), + 'redirections' => array('type' => 'int', 'description' => 'redirect count'), + 'httpcode' => array('type' => 'int', 'description' => 'HTTP status code (20x, 30x, etc.)'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('url'), + 'foreign keys' => array( + 'file_redirection_file_id_fkey' => array('file' => array('file_id' => 'id')), + ), + ); + } + static function _commonHttp($url, $redirs) { $request = new HTTPClient($url); $request->setConfig(array( diff --git a/classes/File_thumbnail.php b/classes/File_thumbnail.php index 17bac7f08c..064b454e2d 100644 --- a/classes/File_thumbnail.php +++ b/classes/File_thumbnail.php @@ -25,7 +25,7 @@ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; * Table Definition for file_thumbnail */ -class File_thumbnail extends Memcached_DataObject +class File_thumbnail extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -43,9 +43,24 @@ class File_thumbnail extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE - function sequenceKey() + public static function schemaDef() { - return array(false, false, false); + return array( + 'fields' => array( + 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'thumbnail for what URL/file'), + 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of thumbnail'), + 'width' => array('type' => 'int', 'description' => 'width of thumbnail'), + 'height' => array('type' => 'int', 'description' => 'height of thumbnail'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('file_id'), + 'foreign keys' => array( + 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')), + ), + 'unique keys' => array( + 'file_thumbnail_url_key' => array('url'), + ), + ); } /** diff --git a/classes/File_to_post.php b/classes/File_to_post.php index bcb6771f4f..1a887a7c18 100644 --- a/classes/File_to_post.php +++ b/classes/File_to_post.php @@ -25,7 +25,7 @@ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; * Table Definition for file_to_post */ -class File_to_post extends Memcached_DataObject +class File_to_post extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -41,6 +41,25 @@ class File_to_post extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'id of URL/file'), + 'post_id' => array('type' => 'int', 'not null' => true, 'description' => 'id of the notice it belongs to'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('file_id', 'post_id'), + 'foreign keys' => array( + 'file_to_post_file_id_fkey' => array('file', array('file_id' => 'id')), + 'file_to_post_post_id_fkey' => array('notice', array('post_id' => 'id')), + ), + 'indexes' => array( + 'post_id_idx' => array('post_id'), + ), + ); + } + function processNew($file_id, $notice_id) { static $seen = array(); if (empty($seen[$notice_id]) || !in_array($file_id, $seen[$notice_id])) { diff --git a/classes/Foreign_link.php b/classes/Foreign_link.php index 57a10dcedb..e3f0cf1ee6 100644 --- a/classes/Foreign_link.php +++ b/classes/Foreign_link.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Foreign_link extends Memcached_DataObject +class Foreign_link extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -29,6 +29,34 @@ class Foreign_link extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'link to user on this system, if exists'), + 'foreign_id' => array('type' => 'int', 'size' => 'big', 'unsigned' => true, 'not null' => true, 'description' => 'link to user on foreign service, if exists'), + 'service' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to service'), + 'credentials' => array('type' => 'varchar', 'length' => 255, 'description' => 'authc credentials, typically a password'), + 'noticesync' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 1, 'description' => 'notice synchronization, bit 1 = sync outgoing, bit 2 = sync incoming, bit 3 = filter local replies'), + 'friendsync' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 2, 'description' => 'friend synchronization, bit 1 = sync outgoing, bit 2 = sync incoming'), + 'profilesync' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 1, 'description' => 'profile synchronization, bit 1 = sync outgoing, bit 2 = sync incoming'), + 'last_noticesync' => array('type' => 'datetime', 'description' => 'last time notices were imported'), + 'last_friendsync' => array('type' => 'datetime', 'description' => 'last time friends were imported'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('user_id', 'foreign_id', 'service'), + 'foreign keys' => array( + 'foreign_link_user_id_fkey' => array('user', array('user_id' => 'id')), + 'foreign_link_foreign_id_fkey' => array('foreign_user', array('foreign_id' => 'id', 'service' => 'service')), + 'foreign_link_service_fkey' => array('foreign_service', array('service' => 'id')), + ), + 'indexes' => array( + 'foreign_user_user_id_idx' => array('user_id'), + ), + ); + } + static function getByUserID($user_id, $service) { if (empty($user_id) || empty($service)) { diff --git a/classes/Foreign_service.php b/classes/Foreign_service.php index dd74fd2ca6..8ba73521c1 100644 --- a/classes/Foreign_service.php +++ b/classes/Foreign_service.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Foreign_service extends Memcached_DataObject +class Foreign_service extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -22,4 +22,21 @@ class Foreign_service extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'int', 'not null' => true, 'description' => 'numeric key for service'), + 'name' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'name of the service'), + 'description' => array('type' => 'varchar', 'length' => 255, 'description' => 'description'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('id'), + 'unique keys' => array( + 'foreign_service_name_key' => array('name'), + ), + ); + } } diff --git a/classes/Foreign_subscription.php b/classes/Foreign_subscription.php index ec2631238e..99bf3868b5 100644 --- a/classes/Foreign_subscription.php +++ b/classes/Foreign_subscription.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Foreign_subscription extends Memcached_DataObject +class Foreign_subscription extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -21,4 +21,27 @@ class Foreign_subscription extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + + public static function schemaDef() + { + return array( + + 'fields' => array( + 'service' => array('type' => 'int', 'not null' => true, 'description' => 'service where relationship happens'), + 'subscriber' => array('type' => 'int', 'size' => 'big', 'not null' => true, 'description' => 'subscriber on foreign service'), + 'subscribed' => array('type' => 'int', 'size' => 'big', 'not null' => true, 'description' => 'subscribed user'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + ), + 'primary key' => array('service', 'subscriber', 'subscribed'), + 'foreign keys' => array( + 'foreign_subscription_service_fkey' => array('foreign_service', array('service' => 'id')), + 'foreign_subscription_subscriber_fkey' => array('foreign_user', array('subscriber' => 'id', 'service' => 'service')), + 'foreign_subscription_subscribed_fkey' => array('foreign_user', array('subscribed' => 'id', 'service' => 'service')), + ), + 'indexes' => array( + 'foreign_subscription_subscriber_idx' => array('service', 'subscriber'), + 'foreign_subscription_subscribed_idx' => array('service', 'subscribed'), + ), + ); + } } diff --git a/classes/Foreign_user.php b/classes/Foreign_user.php index 82ca749a59..67d8651fa9 100644 --- a/classes/Foreign_user.php +++ b/classes/Foreign_user.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Foreign_user extends Memcached_DataObject +class Foreign_user extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -23,6 +23,27 @@ class Foreign_user extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'int', 'size' => 'big', 'not null' => true, 'description' => 'unique numeric key on foreign service'), + 'service' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to service'), + 'uri' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'identifying URI'), + 'nickname' => array('type' => 'varchar', 'length' => 255, 'description' => 'nickname on foreign service'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('id', 'service'), + 'foreign keys' => array( + 'foreign_user_service_fkey' => array('foreign_service', array('service' => 'id')), + ), + 'unique keys' => array( + 'foreign_user_uri_key' => array('uri'), + ), + ); + } + // XXX: This only returns a 1->1 single obj mapping. Change? Or make // a getForeignUsers() that returns more than one? --Zach static function getForeignUser($id, $service) { diff --git a/classes/Group_alias.php b/classes/Group_alias.php index c5a1895a11..fcf5405547 100644 --- a/classes/Group_alias.php +++ b/classes/Group_alias.php @@ -23,7 +23,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Group_alias extends Memcached_DataObject +class Group_alias extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -38,4 +38,22 @@ class Group_alias extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + + public static function schemaDef() + { + return array( + 'fields' => array( + 'alias' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'additional nickname for the group'), + 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'group profile is blocked from'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date alias was created'), + ), + 'primary key' => array('alias'), + 'foreign keys' => array( + 'group_alias_group_id_fkey' => array('user_group', array('group_id' => 'id')), + ), + 'indexes' => array( + 'group_alias_group_id_idx' => array('group_id'), + ), + ); + } } diff --git a/classes/Group_block.php b/classes/Group_block.php index 68feaef4de..dc439ba774 100644 --- a/classes/Group_block.php +++ b/classes/Group_block.php @@ -23,7 +23,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Group_block extends Memcached_DataObject +class Group_block extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -40,6 +40,24 @@ class Group_block extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'group profile is blocked from'), + 'blocked' => array('type' => 'int', 'not null' => true, 'description' => 'profile that is blocked'), + 'blocker' => array('type' => 'int', 'not null' => true, 'description' => 'user making the block'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date of blocking'), + ), + 'primary key' => array('group_id', 'blocked'), + 'foreign keys' => array( + 'group_block_group_id_fkey' => array('user_group', array('group_id' => 'id')), + 'group_block_blocked_fkey' => array('profile', array('blocked' => 'id')), + 'group_block_blocker_fkey' => array('user', array('blocker' => 'id')), + ), + ); + } + function pkeyGet($kv) { return Memcached_DataObject::pkeyGet('Group_block', $kv); diff --git a/classes/Group_inbox.php b/classes/Group_inbox.php index 8f5c65e594..0e01c20b46 100644 --- a/classes/Group_inbox.php +++ b/classes/Group_inbox.php @@ -3,7 +3,7 @@ /** * Table Definition for group_inbox */ -class Group_inbox extends Memcached_DataObject +class Group_inbox extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -20,6 +20,27 @@ class Group_inbox extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'description' => 'Many-many table listing notices posted to a given group, or which groups a given notice was posted to.', + 'fields' => array( + 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'group receiving the message'), + 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice received'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice was created'), + ), + 'primary key' => array('group_id', 'notice_id'), + 'foreign keys' => array( + 'group_inbox_group_id_fkey' => array('user_group', array('group_id' => 'id')), + 'group_inbox_notice_id_fkey' => array('notice', array('notice_id' => 'id')), + ), + 'indexes' => array( + 'group_inbox_created_idx' => array('created'), + 'group_inbox_notice_id_idx' => array('notice_id'), + ), + ); + } + function pkeyGet($kv) { return Memcached_DataObject::pkeyGet('Group_inbox', $kv); diff --git a/classes/Group_member.php b/classes/Group_member.php index 5385e0f487..2ad6589a3c 100644 --- a/classes/Group_member.php +++ b/classes/Group_member.php @@ -3,7 +3,7 @@ * Table Definition for group_member */ -class Group_member extends Memcached_DataObject +class Group_member extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -12,6 +12,7 @@ class Group_member extends Memcached_DataObject public $group_id; // int(4) primary_key not_null public $profile_id; // int(4) primary_key not_null public $is_admin; // tinyint(1) + public $uri; // varchar(255) public $created; // datetime() not_null public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP @@ -21,6 +22,33 @@ class Group_member extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to user_group'), + 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), + 'is_admin' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'is this user an admin?'), + 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universal identifier'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('group_id', 'profile_id'), + 'unique keys' => array( + 'group_member_uri_key' => array('uri'), + ), + 'foreign keys' => array( + 'group_member_group_id_fkey' => array('user_group', array('group_id' => 'id')), + 'group_member_profile_id_fkey' => array('profile', array('profile_id' => 'id')), + ), + 'indexes' => array( + // @fixme probably we want a (profile_id, created) index here? + 'group_member_profile_id_idx' => array('profile_id'), + 'group_member_created_idx' => array('created'), + ), + ); + } + function pkeyGet($kv) { return Memcached_DataObject::pkeyGet('Group_member', $kv); @@ -43,6 +71,7 @@ class Group_member extends Memcached_DataObject $member->group_id = $group_id; $member->profile_id = $profile_id; $member->created = common_sql_now(); + $member->uri = self::newURI($profile_id, $group_id, $member->created); $result = $member->insert(); @@ -134,10 +163,7 @@ class Group_member extends Memcached_DataObject $act = new Activity(); - $act->id = TagURI::mint('join:%d:%d:%s', - $member->id, - $group->id, - common_date_iso8601($this->created)); + $act->id = $this->getURI(); $act->actor = ActivityObject::fromProfile($member); $act->verb = ActivityVerb::JOIN; @@ -171,4 +197,21 @@ class Group_member extends Memcached_DataObject { mail_notify_group_join($this->getGroup(), $this->getMember()); } + + function getURI() + { + if (!empty($this->uri)) { + return $this->uri; + } else { + return self::newURI($this->member_id, $this->group_id, $this->created); + } + } + + static function newURI($member_id, $group_id, $created) + { + return TagURI::mint('join:%d:%d:%s', + $member_id, + $group_id, + common_date_iso8601($created)); + } } diff --git a/classes/Inbox.php b/classes/Inbox.php index 336bba048c..c618ff7aca 100644 --- a/classes/Inbox.php +++ b/classes/Inbox.php @@ -29,7 +29,7 @@ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Inbox extends Memcached_DataObject +class Inbox extends Managed_DataObject { const BOXCAR = 128; const MAX_NOTICES = 1024; @@ -47,9 +47,18 @@ class Inbox extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE - function sequenceKey() + public static function schemaDef() { - return array(false, false, false); + return array( + 'fields' => array( + 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user receiving the notice'), + 'notice_ids' => array('type' => 'blob', 'description' => 'packed list of notice ids'), + ), + 'primary key' => array('user_id'), + 'foreign keys' => array( + 'inbox_user_id_fkey' => array('user', array('user_id' => 'id')), + ), + ); } /** diff --git a/classes/Invitation.php b/classes/Invitation.php index 27ff400883..ae34a31023 100644 --- a/classes/Invitation.php +++ b/classes/Invitation.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Invitation extends Memcached_DataObject +class Invitation extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -30,4 +30,29 @@ class Invitation extends Memcached_DataObject $this->registered_user_id = $user->id; return $this->update($orig); } + + public static function schemaDef() + { + return array( + + 'fields' => array( + 'code' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'random code for an invitation'), + 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'who sent the invitation'), + 'address' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'invitation sent to'), + 'address_type' => array('type' => 'varchar', 'length' => 8, 'not null' => true, 'description' => 'address type ("email", "xmpp", "sms")'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'registered_user_id' => array('type' => 'int', 'not null' => false, 'description' => 'if the invitation is converted, who the new user is'), + ), + 'primary key' => array('code'), + 'foreign keys' => array( + 'invitation_user_id_fkey' => array('user', array('user_id' => 'id')), + 'invitation_registered_user_id_fkey' => array('user', array('registered_user_id' => 'id')), + ), + 'indexes' => array( + 'invitation_address_idx' => array('address', 'address_type'), + 'invitation_user_id_idx' => array('user_id'), + 'invitation_registered_user_id_idx' => array('registered_user_id'), + ), + ); + } } diff --git a/classes/Local_group.php b/classes/Local_group.php index ccd0125cf4..44d8957838 100644 --- a/classes/Local_group.php +++ b/classes/Local_group.php @@ -3,7 +3,7 @@ * Table Definition for local_group */ -class Local_group extends Memcached_DataObject +class Local_group extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -20,9 +20,25 @@ class Local_group extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE - function sequenceKey() + public static function schemaDef() { - return array(false, false, false); + return array( + 'description' => 'Record for a user group on the local site, with some additional info not in user_group', + 'fields' => array( + 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'group represented'), + 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'group represented'), + + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('group_id'), + 'foreign keys' => array( + 'local_group_group_id_fkey' => array('user_group', array('group_id' => 'id')), + ), + 'unique keys' => array( + 'local_group_nickname_key' => array('nickname'), + ), + ); } function setNickname($nickname) diff --git a/classes/Location_namespace.php b/classes/Location_namespace.php index 5ab95d9ef2..7e12447a41 100644 --- a/classes/Location_namespace.php +++ b/classes/Location_namespace.php @@ -25,7 +25,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Location_namespace extends Memcached_DataObject +class Location_namespace extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -43,4 +43,17 @@ class Location_namespace extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'int', 'not null' => true, 'description' => 'identity for this namespace'), + 'description' => array('type' => 'varchar', 'length' => 255, 'description' => 'description of the namespace'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('id'), + ); + } } diff --git a/classes/Login_token.php b/classes/Login_token.php index 7a9388c947..7049c7c7fe 100644 --- a/classes/Login_token.php +++ b/classes/Login_token.php @@ -23,7 +23,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Login_token extends Memcached_DataObject +class Login_token extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -40,21 +40,24 @@ class Login_token extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE - const TIMEOUT = 120; // seconds after which to timeout the token - - /* - DB_DataObject calculates the sequence key(s) by taking the first key returned by the keys() function. - In this case, the keys() function returns user_id as the first key. user_id is not a sequence, but - DB_DataObject's sequenceKey() will incorrectly think it is. Then, since the sequenceKey() is a numeric - type, but is not set to autoincrement in the database, DB_DataObject will create a _seq table and - manage the sequence itself. This is not the correct behavior for the user_id in this class. - So we override that incorrect behavior, and simply say there is no sequence key. - */ - function sequenceKey() + public static function schemaDef() { - return array(false,false); + return array( + 'fields' => array( + 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user owning this token'), + 'token' => array('type' => 'char', 'length' => 32, 'not null' => true, 'description' => 'token useable for logging in'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('user_id'), + 'foreign keys' => array( + 'login_token_user_id_fkey' => array('user', array('user_id' => 'id')), + ), + ); } + const TIMEOUT = 120; // seconds after which to timeout the token + function makeNew($user) { $login_token = Login_token::staticGet('user_id', $user->id); diff --git a/classes/Managed_DataObject.php b/classes/Managed_DataObject.php index 7263b3e320..552d980fba 100644 --- a/classes/Managed_DataObject.php +++ b/classes/Managed_DataObject.php @@ -152,4 +152,18 @@ abstract class Managed_DataObject extends Memcached_DataObject return $style; } + + function links() + { + $links = array(); + + $table = call_user_func(array(get_class($this), 'schemaDef')); + + foreach ($table['foreign keys'] as $keyname => $keydef) { + if (count($keydef) == 2 && is_string($keydef[0]) && is_array($keydef[1]) && count($keydef[1]) == 1) { + $links[$keydef[1][0]] = $keydef[0].':'.$keydef[1][1]; + } + } + return $links; + } } \ No newline at end of file diff --git a/classes/Memcached_DataObject.php b/classes/Memcached_DataObject.php index e1610c56b2..1f15aa4339 100644 --- a/classes/Memcached_DataObject.php +++ b/classes/Memcached_DataObject.php @@ -34,11 +34,12 @@ class Memcached_DataObject extends Safe_DataObject { if (is_null($v)) { $v = $k; - // XXX: HACK! - $i = new $cls; - $keys = $i->keys(); + $keys = self::pkeyCols($cls); + if (count($keys) > 1) { + // FIXME: maybe call pkeyGet() ourselves? + throw new Exception('Use pkeyGet() for compound primary keys'); + } $k = $keys[0]; - unset($i); } $i = Memcached_DataObject::getcached($cls, $k, $v); if ($i === false) { // false == cache miss @@ -63,65 +64,81 @@ class Memcached_DataObject extends Safe_DataObject } return $i; } - + /** * Get multiple items from the database by key - * + * * @param string $cls Class to fetch * @param string $keyCol name of column for key * @param array $keyVals key values to fetch * @param boolean $skipNulls return only non-null results? - * + * * @return array Array of objects, in order */ function multiGet($cls, $keyCol, $keyVals, $skipNulls=true) { - $result = self::pivotGet($cls, $keyCol, $keyVals); - - $values = array_values($result); - - if ($skipNulls) { - $tmp = array(); - foreach ($values as $value) { - if (!empty($value)) { - $tmp[] = $value; - } - } - $values = $tmp; - } - - return new ArrayWrapper($values); + $result = self::pivotGet($cls, $keyCol, $keyVals); + + $values = array_values($result); + + if ($skipNulls) { + $tmp = array(); + foreach ($values as $value) { + if (!empty($value)) { + $tmp[] = $value; + } + } + $values = $tmp; + } + + return new ArrayWrapper($values); } - + /** * Get multiple items from the database by key - * + * * @param string $cls Class to fetch * @param string $keyCol name of column for key * @param array $keyVals key values to fetch * @param boolean $otherCols Other columns to hold fixed - * + * * @return array Array mapping $keyVals to objects, or null if not found */ static function pivotGet($cls, $keyCol, $keyVals, $otherCols = array()) { - $result = array_fill_keys($keyVals, null); + if (is_array($keyCol)) { + foreach ($keyVals as $keyVal) { + $result[implode(',', $keyVal)] = null; + } + } else { + $result = array_fill_keys($keyVals, null); + } $toFetch = array(); foreach ($keyVals as $keyVal) { - - $kv = array_merge($otherCols, array($keyCol => $keyVal)); + + if (is_array($keyCol)) { + $kv = array_combine($keyCol, $keyVal); + } else { + $kv = array($keyCol => $keyVal); + } + + $kv = array_merge($otherCols, $kv); $i = self::multicache($cls, $kv); if ($i !== false) { - $result[$keyVal] = $i; + if (is_array($keyCol)) { + $result[implode(',', $keyVal)] = $i; + } else { + $result[$keyVal] = $i; + } } else if (!empty($keyVal)) { $toFetch[] = $keyVal; } } - + if (count($toFetch) > 0) { $i = DB_DataObject::factory($cls); if (empty($i)) { @@ -130,20 +147,43 @@ class Memcached_DataObject extends Safe_DataObject foreach ($otherCols as $otherKeyCol => $otherKeyVal) { $i->$otherKeyCol = $otherKeyVal; } - $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol)); + if (is_array($keyCol)) { + $i->whereAdd(self::_inMultiKey($i, $keyCol, $toFetch)); + } else { + $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol)); + } if ($i->find()) { while ($i->fetch()) { $copy = clone($i); $copy->encache(); - $result[$i->$keyCol] = $copy; + if (is_array($keyCol)) { + $vals = array(); + foreach ($keyCol as $k) { + $vals[] = $i->$k; + } + $result[implode(',', $vals)] = $copy; + } else { + $result[$i->$keyCol] = $copy; + } } } // Save state of DB misses foreach ($toFetch as $keyVal) { - if (empty($result[$keyVal])) { - $kv = array_merge($otherCols, array($keyCol => $keyVal)); + $r = null; + if (is_array($keyCol)) { + $r = $result[implode(',', $keyVal)]; + } else { + $r = $result[$keyVal]; + } + if (empty($r)) { + if (is_array($keyCol)) { + $kv = array_combine($keyCol, $keyVal); + } else { + $kv = array($keyCol => $keyVal); + } + $kv = array_merge($otherCols, $kv); // save the fact that no such row exists $c = self::memcache(); if (!empty($c)) { @@ -153,45 +193,140 @@ class Memcached_DataObject extends Safe_DataObject } } } - + return $result; } - + + static function _inMultiKey($i, $cols, $values) + { + $types = array(); + + foreach ($cols as $col) { + $types[$col] = $i->columnType($col); + } + + $first = true; + + $query = ''; + + foreach ($values as $value) { + if ($first) { + $query .= '( '; + $first = false; + } else { + $query .= ' OR '; + } + $query .= '( '; + $i = 0; + $firstc = true; + foreach ($cols as $col) { + if (!$firstc) { + $query .= ' AND '; + } else { + $firstc = false; + } + switch ($types[$col]) { + case 'string': + case 'datetime': + $query .= sprintf("%s = %s", $col, $i->_quote($value[$i])); + break; + default: + $query .= sprintf("%s = %s", $col, $value[$i]); + break; + } + } + $query .= ') '; + } + + if (!$first) { + $query .= ' )'; + } + + return $query; + } + + static function pkeyCols($cls) + { + $i = DB_DataObject::factory($cls); + if (empty($i)) { + throw new Exception(_('Cannot instantiate a ' . $cls)); + } + $types = $i->keyTypes(); + ksort($types); + + $pkey = array(); + + foreach ($types as $key => $type) { + if ($type == 'K' || $type == 'N') { + $pkey[] = $key; + } + } + + return $pkey; + } + function listGet($cls, $keyCol, $keyVals) { - $result = array_fill_keys($keyVals, array()); - + $pkeyMap = array_fill_keys($keyVals, array()); + $result = array_fill_keys($keyVals, array()); + + $pkeyCols = self::pkeyCols($cls); + $toFetch = array(); - + $allPkeys = array(); + + // We only cache keys -- not objects! + foreach ($keyVals as $keyVal) { - $l = self::cacheGet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal)); + $l = self::cacheGet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal)); if ($l !== false) { - $result[$keyVal] = $l; + $pkeyMap[$keyVal] = $l; + foreach ($l as $pkey) { + $allPkeys[] = $pkey; + } } else { $toFetch[] = $keyVal; } } - + + if (count($allPkeys) > 0) { + $keyResults = self::pivotGet($cls, $pkeyCols, $allPkeys); + + foreach ($pkeyMap as $keyVal => $pkeyList) { + foreach ($pkeyList as $pkeyVal) { + $i = $keyResults[implode(',',$pkeyVal)]; + if (!empty($i)) { + $result[$keyVal][] = $i; + } + } + } + } + if (count($toFetch) > 0) { $i = DB_DataObject::factory($cls); if (empty($i)) { throw new Exception(_('Cannot instantiate class ' . $cls)); } - $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol)); - if ($i->find()) { - while ($i->fetch()) { - $copy = clone($i); - $copy->encache(); - $result[$i->$keyCol][] = $copy; - } - } - foreach ($toFetch as $keyVal) - { - self::cacheSet(sprintf("%s:list:%s:%s", $cls, $keyCol, $keyVal), - $result[$keyVal]); - } + $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol)); + if ($i->find()) { + sprintf("listGet() got {$i->N} results for class $cls key $keyCol"); + while ($i->fetch()) { + $copy = clone($i); + $copy->encache(); + $result[$i->$keyCol][] = $copy; + $pkeyVal = array(); + foreach ($pkeyCols as $pkeyCol) { + $pkeyVal[] = $i->$pkeyCol; + } + $pkeyMap[$i->$keyCol][] = $pkeyVal; + } + } + foreach ($toFetch as $keyVal) { + self::cacheSet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal), + $pkeyMap[$keyVal]); + } } - + return $result; } @@ -212,7 +347,7 @@ class Memcached_DataObject extends Safe_DataObject } /** - * @fixme Should this return false on lookup fail to match staticGet? + * @todo FIXME: Should this return false on lookup fail to match staticGet? */ function pkeyGet($cls, $kv) { @@ -225,13 +360,13 @@ class Memcached_DataObject extends Safe_DataObject return false; } foreach ($kv as $k => $v) { - if (is_null($v)) { - // XXX: possible SQL injection...? Don't - // pass keys from the browser, eh. - $i->whereAdd("$k is null"); - } else { - $i->$k = $v; - } + if (is_null($v)) { + // XXX: possible SQL injection...? Don't + // pass keys from the browser, eh. + $i->whereAdd("$k is null"); + } else { + $i->$k = $v; + } } if ($i->find(true)) { $i->encache(); @@ -562,7 +697,7 @@ class Memcached_DataObject extends Safe_DataObject continue; } if (in_array($func, $ignoreStatic)) { - continue; // @fixme this shouldn't be needed? + continue; // @todo FIXME: This shouldn't be needed? } $here = get_class($frame['object']) . '->' . $func; break; @@ -705,7 +840,7 @@ class Memcached_DataObject extends Safe_DataObject if (!$dsn) { // TRANS: Exception thrown when database name or Data Source Name could not be found. - throw new Exception(_("No database name or DSN found anywhere.")); + throw new Exception(_('No database name or DSN found anywhere.')); } return $dsn; diff --git a/classes/Message.php b/classes/Message.php index 484d1f724c..e04b4f47e3 100644 --- a/classes/Message.php +++ b/classes/Message.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Message extends Memcached_DataObject +class Message extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -27,6 +27,39 @@ class Message extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), + 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier'), + 'from_profile' => array('type' => 'int', 'not null' => true, 'description' => 'who the message is from'), + 'to_profile' => array('type' => 'int', 'not null' => true, 'description' => 'who the message is to'), + 'content' => array('type' => 'text', 'description' => 'message content'), + 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'), + 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of any attachment (image, video, bookmark, whatever)'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'), + ), + 'primary key' => array('id'), + 'unique keys' => array( + 'message_uri_key' => array('uri'), + ), + 'foreign keys' => array( + 'message_from_profile_fkey' => array('profile', array('from_profile' => 'id')), + 'message_to_profile_fkey' => array('profile', array('to_profile' => 'id')), + ), + 'indexes' => array( + // @fixme these are really terrible indexes, since you can only sort on one of them at a time. + // looks like we really need a (to_profile, created) for inbox and a (from_profile, created) for outbox + 'message_from_idx' => array('from_profile'), + 'message_to_idx' => array('to_profile'), + 'message_created_idx' => array('created'), + ), + ); + } + function getFrom() { return Profile::staticGet('id', $this->from_profile); diff --git a/classes/Nonce.php b/classes/Nonce.php index 93191bd409..0cd9967a08 100644 --- a/classes/Nonce.php +++ b/classes/Nonce.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Nonce extends Memcached_DataObject +class Nonce extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -36,4 +36,21 @@ class Nonce extends Memcached_DataObject { return array('consumer_key,token' => 'token:consumer_key,token'); } + + public static function schemaDef() + { + return array( + 'description' => 'OAuth nonce record', + 'fields' => array( + 'consumer_key' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'unique identifier, root URL'), + 'tok' => array('type' => 'char', 'length' => 32, 'description' => 'buggy old value, ignored'), + 'nonce' => array('type' => 'char', 'length' => 32, 'not null' => true, 'description' => 'nonce'), + 'ts' => array('type' => 'datetime', 'not null' => true, 'description' => 'timestamp sent'), + + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('consumer_key', 'ts', 'nonce'), + ); + } } diff --git a/classes/Notice.php b/classes/Notice.php index d39aea6c22..15696f6eef 100644 --- a/classes/Notice.php +++ b/classes/Notice.php @@ -49,7 +49,7 @@ define('NOTICE_CACHE_WINDOW', CachingNoticeStream::CACHE_WINDOW); define('MAX_BOXCARS', 128); -class Notice extends Memcached_DataObject +class Notice extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -72,6 +72,7 @@ class Notice extends Memcached_DataObject public $location_id; // int(4) public $location_ns; // int(4) public $repeat_of; // int(4) + public $verb; // varchar(255) public $object_type; // varchar(255) public $scope; // int(4) @@ -84,6 +85,56 @@ class Notice extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), + 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'who made the update'), + 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'), + 'content' => array('type' => 'text', 'description' => 'update content'), + 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'), + 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of any attachment (image, video, bookmark, whatever)'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + 'reply_to' => array('type' => 'int', 'description' => 'notice replied to (usually a guess)'), + 'is_local' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'notice was generated by a user'), + 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'), + 'conversation' => array('type' => 'int', 'description' => 'id of root notice in this conversation'), + 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'), + 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'), + 'location_id' => array('type' => 'int', 'description' => 'location id if possible'), + 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'), + 'repeat_of' => array('type' => 'int', 'description' => 'notice this is a repeat of'), + 'object_type' => array('type' => 'varchar', 'length' => 255, 'description' => 'URI representing activity streams object type', 'default' => 'http://activitystrea.ms/schema/1.0/note'), + 'verb' => array('type' => 'varchar', 'length' => 255, 'description' => 'URI representing activity streams verb', 'default' => 'http://activitystrea.ms/schema/1.0/post'), + 'scope' => array('type' => 'int', + 'default' => '1', + 'description' => 'bit map for distribution scope; 0 = everywhere; 1 = this server only; 2 = addressees; 4 = followers'), + ), + 'primary key' => array('id'), + 'unique keys' => array( + 'notice_uri_key' => array('uri'), + ), + 'foreign keys' => array( + 'notice_profile_id_fkey' => array('profile', array('profile_id' => 'id')), + 'notice_reply_to_fkey' => array('notice', array('reply_to' => 'id')), + 'notice_conversation_fkey' => array('conversation', array('conversation' => 'id')), # note... used to refer to notice.id + 'notice_repeat_of_fkey' => array('notice', array('repeat_of' => 'id')), # @fixme: what about repeats of deleted notices? + ), + 'indexes' => array( + 'notice_profile_id_idx' => array('profile_id', 'created', 'id'), + 'notice_conversation_idx' => array('conversation'), + 'notice_created_idx' => array('created'), + 'notice_replyto_idx' => array('reply_to'), + 'notice_repeatof_idx' => array('repeat_of'), + ), + 'fulltext indexes' => array( + 'content' => array('content'), + ) + ); + } + function multiGet($kc, $kvs, $skipNulls=true) { return Memcached_DataObject::multiGet('Notice', $kc, $kvs, $skipNulls); @@ -264,6 +315,7 @@ class Notice extends Memcached_DataObject * notice in place of extracting links from content * boolean 'distribute' whether to distribute the notice, default true * string 'object_type' URL of the associated object type (default ActivityObject::NOTE) + * string 'verb' URL of the associated verb (default ActivityVerb::POST) * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise * * @fixme tag override @@ -277,7 +329,9 @@ class Notice extends Memcached_DataObject 'reply_to' => null, 'repeat_of' => null, 'scope' => null, - 'distribute' => true); + 'distribute' => true, + 'object_type' => null, + 'verb' => null); if (!empty($options) && is_array($options)) { $options = array_merge($defaults, $options); @@ -448,6 +502,17 @@ class Notice extends Memcached_DataObject $notice->rendered = common_render_content($final, $notice); } + if (empty($verb)) { + if (!empty($notice->repeat_of)) { + $notice->verb = ActivityVerb::SHARE; + $notice->object_type = ActivityVerb::ACTIVITY; + } else { + $notice->verb = ActivityVerb::POST; + } + } else { + $notice->verb = $verb; + } + if (empty($object_type)) { $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT; } else { @@ -577,14 +642,13 @@ class Notice extends Memcached_DataObject $this->blowStream('public'); } - // XXX: Before we were blowing the casche only if the notice id - // was not the root of the conversation. What to do now? - - self::blow('notice:conversation_ids:%d', $this->conversation); + self::blow('notice:list-ids:conversation:%s', $this->conversation); self::blow('conversation::notice_count:%d', $this->conversation); if (!empty($this->repeat_of)) { + // XXX: we should probably only use one of these $this->blowStream('notice:repeats:%d', $this->repeat_of); + self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of); } $original = Notice::staticGet('id', $this->repeat_of); @@ -1445,18 +1509,13 @@ class Notice extends Memcached_DataObject $act->actor = ActivityObject::fromProfile($profile); $act->actor->extra[] = $profile->profileInfo($cur); + $act->verb = $this->verb; + if ($this->repeat_of) { - $repeated = Notice::staticGet('id', $this->repeat_of); - - $act->verb = ActivityVerb::SHARE; - $act->objects[] = $repeated->asActivity($cur); - + $act->objects[] = $repeated->asActivity($cur); } else { - - $act->verb = ActivityVerb::POST; - $act->objects[] = ActivityObject::fromNotice($this); - + $act->objects[] = ActivityObject::fromNotice($this); } // XXX: should this be handled by default processing for object entry? @@ -2435,7 +2494,7 @@ class Notice extends Memcached_DataObject function __sleep() { $vars = parent::__sleep(); - $skip = array('_original', '_profile', '_groups', '_attachments', '_faves', '_replies'); + $skip = array('_original', '_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats'); return array_diff($vars, $skip); } @@ -2547,7 +2606,7 @@ class Notice extends Memcached_DataObject } } - protected $_faves = -1; + protected $_faves; /** * All faves of this notice @@ -2557,11 +2616,11 @@ class Notice extends Memcached_DataObject function getFaves() { - if ($this->_faves != -1) { + if (isset($this->_faves) && is_array($this->_faves)) { return $this->_faves; } - $faveMap = Memcached_DataObject::listGet('Fave', 'notice_id', array($noticeId)); - $this->_faves = $faveMap[$noticeId]; + $faveMap = Memcached_DataObject::listGet('Fave', 'notice_id', array($this->id)); + $this->_faves = $faveMap[$this->id]; return $this->_faves; } @@ -2574,8 +2633,17 @@ class Notice extends Memcached_DataObject { $ids = self::_idsOf($notices); $faveMap = Memcached_DataObject::listGet('Fave', 'notice_id', $ids); + $cnt = 0; + $faved = array(); + foreach ($faveMap as $id => $faves) { + $cnt += count($faves); + if (count($faves) > 0) { + $faved[] = $id; + } + } foreach ($notices as $notice) { - $notice->_setFaves($faveMap[$notice->id]); + $faves = $faveMap[$notice->id]; + $notice->_setFaves($faves); } } @@ -2592,4 +2660,31 @@ class Notice extends Memcached_DataObject $notice->_setReplies($ids); } } + + protected $_repeats; + + function getRepeats() + { + if (isset($this->_repeats) && is_array($this->_repeats)) { + return $this->_repeats; + } + $repeatMap = Memcached_DataObject::listGet('Notice', 'repeat_of', array($this->id)); + $this->_repeats = $repeatMap[$this->id]; + return $this->_repeats; + } + + function _setRepeats($repeats) + { + $this->_repeats = $repeats; + } + + static function fillRepeats(&$notices) + { + $ids = self::_idsOf($notices); + $repeatMap = Memcached_DataObject::listGet('Notice', 'repeat_of', $ids); + foreach ($notices as $notice) { + $repeats = $repeatMap[$notice->id]; + $notice->_setRepeats($repeats); + } + } } diff --git a/classes/Notice_inbox.php b/classes/Notice_inbox.php index 47ed6b22db..dcaf2f33b1 100644 --- a/classes/Notice_inbox.php +++ b/classes/Notice_inbox.php @@ -31,7 +31,7 @@ define('NOTICE_INBOX_GC_MAX', 12800); define('NOTICE_INBOX_LIMIT', 1000); define('NOTICE_INBOX_SOFT_LIMIT', 1000); -class Notice_inbox extends Memcached_DataObject +class Notice_inbox extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -49,6 +49,27 @@ class Notice_inbox extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'description' => 'Obsolete; old entries here are converted to packed entries in the inbox table since 0.9', + 'fields' => array( + 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user receiving the message'), + 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice received'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice was created'), + 'source' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'reason it is in the inbox, 1=subscription'), + ), + 'primary key' => array('user_id', 'notice_id'), + 'foreign keys' => array( + 'notice_inbox_user_id_fkey' => array('user', array('user_id' => 'id')), + 'notice_inbox_notice_id_fkey' => array('notice', array('notice_id' => 'id')), + ), + 'indexes' => array( + 'notice_inbox_notice_id_idx' => array('notice_id'), + ), + ); + } + function stream($user_id, $offset, $limit, $since_id, $max_id, $own=false) { throw new Exception('Notice_inbox no longer used; use Inbox'); diff --git a/classes/Notice_source.php b/classes/Notice_source.php index 43893ebe18..a6649f5fba 100644 --- a/classes/Notice_source.php +++ b/classes/Notice_source.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Notice_source extends Memcached_DataObject +class Notice_source extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -22,4 +22,19 @@ class Notice_source extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + + public static function schemaDef() + { + return array( + 'fields' => array( + 'code' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'source code'), + 'name' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'name of the source'), + 'url' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'url to link to'), + 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'date this record was created'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('code'), + ); + } } diff --git a/classes/Notice_tag.php b/classes/Notice_tag.php index 809403a9bd..77c89dc8ce 100644 --- a/classes/Notice_tag.php +++ b/classes/Notice_tag.php @@ -19,7 +19,7 @@ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Notice_tag extends Memcached_DataObject +class Notice_tag extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -36,6 +36,26 @@ class Notice_tag extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'description' => 'Hash tags', + 'fields' => array( + 'tag' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'hash tag associated with this notice'), + 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice tagged'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + ), + 'primary key' => array('tag', 'notice_id'), + 'foreign keys' => array( + 'notice_tag_notice_id_fkey' => array('notice', array('notice_id' => 'id')), + ), + 'indexes' => array( + 'notice_tag_created_idx' => array('created'), + 'notice_tag_notice_id_idx' => array('notice_id'), + ), + ); + } + static function getStream($tag, $offset=0, $limit=20, $sinceId=0, $maxId=0) { $stream = new TagNoticeStream($tag); diff --git a/classes/Oauth_application.php b/classes/Oauth_application.php index f1d4fb7a6f..15faffe2fb 100644 --- a/classes/Oauth_application.php +++ b/classes/Oauth_application.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Oauth_application extends Memcached_DataObject +class Oauth_application extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -159,4 +159,35 @@ class Oauth_application extends Memcached_DataObject $oauser->application_id = $this->id; $oauser->delete(); } + + public static function schemaDef() + { + return array( + 'description' => 'OAuth application registration record', + 'fields' => array( + 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), + 'owner' => array('type' => 'int', 'not null' => true, 'description' => 'owner of the application'), + 'consumer_key' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'application consumer key'), + 'name' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'name of the application'), + 'description' => array('type' => 'varchar', 'length' => 255, 'description' => 'description of the application'), + 'icon' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'application icon'), + 'source_url' => array('type' => 'varchar', 'length' => 255, 'description' => 'application homepage - used for source link'), + 'organization' => array('type' => 'varchar', 'length' => 255, 'description' => 'name of the organization running the application'), + 'homepage' => array('type' => 'varchar', 'length' => 255, 'description' => 'homepage for the organization'), + 'callback_url' => array('type' => 'varchar', 'length' => 255, 'description' => 'url to redirect to after authentication'), + 'type' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'type of app, 1 = browser, 2 = desktop'), + 'access_type' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'default access type, bit 1 = read, bit 2 = write'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('id'), + 'unique keys' => array( + 'oauth_application_name_key' => array('name'), // in the long run, we should perhaps not force these unique, and use another source id + ), + 'foreign keys' => array( + 'oauth_application_owner_fkey' => array('profile', array('owner' => 'id')), // Are remote users allowed to create oauth application records? + 'oauth_application_consumer_key_fkey' => array('consumer', array('consumer_key' => 'consumer_key')), + ), + ); + } } diff --git a/classes/Oauth_application_user.php b/classes/Oauth_application_user.php index 834e38d2be..4d25672465 100644 --- a/classes/Oauth_application_user.php +++ b/classes/Oauth_application_user.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Oauth_application_user extends Memcached_DataObject +class Oauth_application_user extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -24,6 +24,25 @@ class Oauth_application_user extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'user of the application'), + 'application_id' => array('type' => 'int', 'not null' => true, 'description' => 'id of the application'), + 'access_type' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'access type, bit 1 = read, bit 2 = write'), + 'token' => array('type' => 'varchar', 'length' => 255, 'description' => 'request or access token'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('profile_id', 'application_id'), + 'foreign keys' => array( + 'oauth_application_user_profile_id_fkey' => array('profile', array('profile_id' => 'id')), + 'oauth_application_user_application_id_fkey' => array('oauth_application', array('application_id' => 'id')), + ), + ); + } + static function getByUserAndToken($user, $token) { if (empty($user) || empty($token)) { diff --git a/classes/Oauth_token_association.php b/classes/Oauth_token_association.php index 06c9fee1c3..17327d4b01 100644 --- a/classes/Oauth_token_association.php +++ b/classes/Oauth_token_association.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR . '/classes/Memcached_DataObject.php'; -class Oauth_token_association extends Memcached_DataObject +class Oauth_token_association extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ diff --git a/classes/Profile.php b/classes/Profile.php index d5008d9fb8..228a0ae202 100644 --- a/classes/Profile.php +++ b/classes/Profile.php @@ -24,7 +24,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Profile extends Memcached_DataObject +class Profile extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -49,6 +49,36 @@ class Profile extends Memcached_DataObject return Memcached_DataObject::staticGet('Profile',$k,$v); } + public static function schemaDef() + { + return array( + 'description' => 'local and remote users have profiles', + 'fields' => array( + 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), + 'nickname' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'nickname or username'), + 'fullname' => array('type' => 'varchar', 'length' => 255, 'description' => 'display name'), + 'profileurl' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL, cached so we dont regenerate'), + 'homepage' => array('type' => 'varchar', 'length' => 255, 'description' => 'identifying URL'), + 'bio' => array('type' => 'text', 'description' => 'descriptive biography'), + 'location' => array('type' => 'varchar', 'length' => 255, 'description' => 'physical location'), + 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'), + 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'), + 'location_id' => array('type' => 'int', 'description' => 'location id if possible'), + 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'), + + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('id'), + 'indexes' => array( + 'profile_nickname_idx' => array('nickname'), + ), + 'fulltext indexes' => array( + 'nickname' => array('nickname', 'fullname', 'location', 'bio', 'homepage') + ), + ); + } + function multiGet($keyCol, $keyVals, $skipNulls=true) { return parent::multiGet('Profile', $keyCol, $keyVals, $skipNulls); @@ -405,6 +435,7 @@ class Profile extends Memcached_DataObject $tags->tagged = $this->id; $lists->joinAdd($tags); + #@fixme: postgres (round(date_part('epoch', my_date))) $lists->selectAdd('unix_timestamp(profile_tag.modified) as "cursor"'); @@ -477,7 +508,8 @@ class Profile extends Memcached_DataObject $lists = new Profile_list(); $subs = new Profile_tag_subscription(); - $lists->joinAdd($subs); + $lists->joinAdd('id', 'profile_tag_subscription:profile_tag_id'); + #@fixme: postgres (round(date_part('epoch', my_date))) $lists->selectAdd('unix_timestamp(profile_tag_subscription.created) as "cursor"'); diff --git a/classes/Profile_block.php b/classes/Profile_block.php index 2d87edaa0a..8506283462 100644 --- a/classes/Profile_block.php +++ b/classes/Profile_block.php @@ -25,7 +25,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Profile_block extends Memcached_DataObject +class Profile_block extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -42,6 +42,22 @@ class Profile_block extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'blocker' => array('type' => 'int', 'not null' => true, 'description' => 'user making the block'), + 'blocked' => array('type' => 'int', 'not null' => true, 'description' => 'profile that is blocked'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date of blocking'), + ), + 'foreign keys' => array( + 'profile_block_blocker_fkey' => array('user', array('blocker' => 'id')), + 'profile_block_blocked_fkey' => array('profile', array('blocked' => 'id')), + ), + 'primary key' => array('blocker', 'blocked'), + ); + } + function get($blocker, $blocked) { return Memcached_DataObject::pkeyGet('Profile_block', diff --git a/classes/Profile_list.php b/classes/Profile_list.php index 2395a369f3..c433a53fee 100644 --- a/classes/Profile_list.php +++ b/classes/Profile_list.php @@ -30,7 +30,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Profile_list extends Memcached_DataObject +class Profile_list extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -54,6 +54,41 @@ class Profile_list extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), + 'tagger' => array('type' => 'int', 'not null' => true, 'description' => 'user making the tag'), + 'tag' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'people tag'), + 'description' => array('type' => 'text', 'description' => 'description of the people tag'), + 'private' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'is this tag private'), + + 'created' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date the tag was added'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date the tag was modified'), + + 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universal identifier'), + 'mainpage' => array('type' => 'varchar', 'length' => 255, 'description' => 'page to link to'), + 'tagged_count' => array('type' => 'int', 'default' => 0, 'description' => 'number of people tagged with this tag by this user'), + 'subscriber_count' => array('type' => 'int', 'default' => 0, 'description' => 'number of subscribers to this tag'), + ), + 'primary key' => array('tagger', 'tag'), + 'unique keys' => array( + 'profile_list_id_key' => array('id') + ), + 'foreign keys' => array( + 'profile_list_tagger_fkey' => array('profile', array('tagger' => 'id')), + ), + 'indexes' => array( + 'profile_list_modified_idx' => array('modified'), + 'profile_list_tag_idx' => array('tag'), + 'profile_list_tagger_tag_idx' => array('tagger', 'tag'), + 'profile_list_tagged_count_idx' => array('tagged_count'), + 'profile_list_subscriber_count_idx' => array('subscriber_count'), + ), + ); + } + /** * return a profile_list record, given its tag and tagger. * @@ -185,10 +220,9 @@ class Profile_list extends Memcached_DataObject function getSubscribers($offset=0, $limit=null, $since=0, $upto=0) { $subs = new Profile(); - $sub = new Profile_tag_subscription(); - $sub->profile_tag_id = $this->id; - $subs->joinAdd($sub); + $subs->joinAdd(array('id', 'profile_tag_subscription:profile_tag_id')); + $subs->selectAdd('unix_timestamp(profile_tag_subscription.' . 'created) as "cursor"'); diff --git a/classes/Profile_role.php b/classes/Profile_role.php index e7aa1f0f06..d89992b842 100644 --- a/classes/Profile_role.php +++ b/classes/Profile_role.php @@ -27,7 +27,7 @@ if (!defined('STATUSNET')) { require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Profile_role extends Memcached_DataObject +class Profile_role extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -43,6 +43,21 @@ class Profile_role extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'account having the role'), + 'role' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'string representing the role'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the role was granted'), + ), + 'primary key' => array('profile_id', 'role'), + 'foreign keys' => array( + 'profile_role_profile_id_fkey' => array('profile', array('profile_id' => 'id')), + ), + ); + } + function pkeyGet($kv) { return Memcached_DataObject::pkeyGet('Profile_role', $kv); diff --git a/classes/Profile_tag.php b/classes/Profile_tag.php index 9e475e83ec..d9b094182f 100644 --- a/classes/Profile_tag.php +++ b/classes/Profile_tag.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Profile_tag extends Memcached_DataObject +class Profile_tag extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -22,6 +22,30 @@ class Profile_tag extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + + 'fields' => array( + 'tagger' => array('type' => 'int', 'not null' => true, 'description' => 'user making the tag'), + 'tagged' => array('type' => 'int', 'not null' => true, 'description' => 'profile tagged'), + 'tag' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'hash tag associated with this notice'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date the tag was added'), + ), + 'primary key' => array('tagger', 'tagged', 'tag'), + 'foreign keys' => array( + 'profile_tag_tagger_fkey' => array('profile', array('tagger' => 'id')), + 'profile_tag_tagged_fkey' => array('profile', array('tagged' => 'id')), + 'profile_tag_tag_fkey' => array('profile_list', array('tag' => 'tag')), + ), + 'indexes' => array( + 'profile_tag_modified_idx' => array('modified'), + 'profile_tag_tagger_tag_idx' => array('tagger', 'tag'), + 'profile_tag_tagged_idx' => array('tagged'), + ), + ); + } + function pkeyGet($kv) { return Memcached_DataObject::pkeyGet('Profile_tag', $kv); } diff --git a/classes/Profile_tag_subscription.php b/classes/Profile_tag_subscription.php index 031405f531..ce4a57e870 100644 --- a/classes/Profile_tag_subscription.php +++ b/classes/Profile_tag_subscription.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Profile_tag_subscription extends Memcached_DataObject +class Profile_tag_subscription extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -22,6 +22,29 @@ class Profile_tag_subscription extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'profile_tag_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile_tag'), + 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), + + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('profile_tag_id', 'profile_id'), + 'foreign keys' => array( + 'profile_tag_subscription_profile_list_id_fkey' => array('profile_list', array('profile_tag_id' => 'id')), + 'profile_tag_subscription_profile_id_fkey' => array('profile', array('profile_id' => 'id')), + ), + 'indexes' => array( + // @fixme probably we want a (profile_id, created) index here? + 'profile_tag_subscription_profile_id_idx' => array('profile_id'), + 'profile_tag_subscription_created_idx' => array('created'), + ), + ); + } + function pkeyGet($kv) { return Memcached_DataObject::pkeyGet('Profile_tag_subscription', $kv); diff --git a/classes/Queue_item.php b/classes/Queue_item.php index d17e512b96..e34a89d2e3 100644 --- a/classes/Queue_item.php +++ b/classes/Queue_item.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Queue_item extends Memcached_DataObject +class Queue_item extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -22,6 +22,23 @@ class Queue_item extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), + 'frame' => array('type' => 'blob', 'not null' => true, 'description' => 'data: object reference or opaque string'), + 'transport' => array('type' => 'varchar', 'length' => 8, 'not null' => true, 'description' => 'queue for what? "email", "xmpp", "sms", "irc", ...'), // @fixme 8 chars is too short; bump up. + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'claimed' => array('type' => 'datetime', 'description' => 'date this item was claimed'), + ), + 'primary key' => array('id'), + 'indexes' => array( + 'queue_item_created_idx' => array('created'), + ), + ); + } + /** * @param mixed $transports name of a single queue or array of queues to pull from * If not specified, checks all queues in the system. diff --git a/classes/Related_group.php b/classes/Related_group.php index c00ad9c44e..67d6ce3fc7 100644 --- a/classes/Related_group.php +++ b/classes/Related_group.php @@ -3,7 +3,7 @@ * Table Definition for related_group */ -class Related_group extends Memcached_DataObject +class Related_group extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -18,4 +18,22 @@ class Related_group extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + + public static function schemaDef() + { + return array( + // @fixme description for related_group? + 'fields' => array( + 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to user_group'), + 'related_group_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to user_group'), + + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + ), + 'primary key' => array('group_id', 'related_group_id'), + 'foreign keys' => array( + 'related_group_group_id_fkey' => array('user_group', array('group_id' => 'id')), + 'related_group_related_group_id_fkey' => array('user_group', array('related_group_id' => 'id')), + ), + ); + } } diff --git a/classes/Remember_me.php b/classes/Remember_me.php index 3df7a99831..6523ad8174 100644 --- a/classes/Remember_me.php +++ b/classes/Remember_me.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Remember_me extends Memcached_DataObject +class Remember_me extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -23,8 +23,18 @@ class Remember_me extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE - function sequenceKey() + public static function schemaDef() { - return array(false, false); - } + return array( + 'fields' => array( + 'code' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'good random code'), + 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who is logged in'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('code'), + 'foreign keys' => array( + 'remember_me_user_id_fkey' => array('user', array('user_id' => 'id')), + ), + ); + } } diff --git a/classes/Remote_profile.php b/classes/Remote_profile.php index 1672e9f956..d59f97ada7 100644 --- a/classes/Remote_profile.php +++ b/classes/Remote_profile.php @@ -24,7 +24,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Remote_profile extends Memcached_DataObject +class Remote_profile extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -54,4 +54,26 @@ class Remote_profile extends Memcached_DataObject throw new Exception(_("Missing profile.")); } } + + public static function schemaDef() + { + return array( + 'description' => 'remote people (OMB)', + 'fields' => array( + 'id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), + 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'), + 'postnoticeurl' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL we use for posting notices'), + 'updateprofileurl' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL we use for updates to this profile'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('id'), + 'unique keys' => array( + 'remote_profile_uri_key' => array('uri'), + ), + 'foreign keys' => array( + 'remote_profile_id_fkey' => array('profile', array('id' => 'id')), + ), + ); + } } diff --git a/classes/Reply.php b/classes/Reply.php index acda0fecb4..3cc4b942ca 100644 --- a/classes/Reply.php +++ b/classes/Reply.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Reply extends Memcached_DataObject +class Reply extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -22,6 +22,28 @@ class Reply extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice that is the reply'), + 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'profile replied to'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + 'replied_id' => array('type' => 'int', 'description' => 'notice replied to (not used, see notice.reply_to)'), + ), + 'primary key' => array('notice_id', 'profile_id'), + 'foreign keys' => array( + 'reply_notice_id_fkey' => array('notice', array('notice_id' => 'id')), + 'reply_profile_id_fkey' => array('profile', array('profile_id' => 'id')), + ), + 'indexes' => array( + 'reply_notice_id_idx' => array('notice_id'), + 'reply_profile_id_idx' => array('profile_id'), + 'reply_replied_id_idx' => array('replied_id'), + ), + ); + } + function pkeyGet($kv) { return Memcached_DataObject::pkeyGet('Reply',$kv); diff --git a/classes/Schema_version.php b/classes/Schema_version.php index 6b464c6d1d..4a3f939e93 100644 --- a/classes/Schema_version.php +++ b/classes/Schema_version.php @@ -3,7 +3,7 @@ * Table Definition for schema_version */ -class Schema_version extends Memcached_DataObject +class Schema_version extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -19,4 +19,17 @@ class Schema_version extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + + public static function schemaDef() + { + return array( + 'description' => 'To avoid checking database structure all the time, we store a checksum of the expected schema info for each table here. If it has not changed since the last time we checked the table, we can leave it as is.', + 'fields' => array( + 'table_name' => array('type' => 'varchar', 'length' => '64', 'not null' => true, 'description' => 'Table name'), + 'checksum' => array('type' => 'varchar', 'length' => '64', 'not null' => true, 'description' => 'Checksum of schema array; a mismatch indicates we should check the table more thoroughly.'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('table_name'), + ); + } } diff --git a/classes/Session.php b/classes/Session.php index 166b89815a..1a924b7964 100644 --- a/classes/Session.php +++ b/classes/Session.php @@ -23,7 +23,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Session extends Memcached_DataObject +class Session extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -40,6 +40,22 @@ class Session extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'session ID'), + 'session_data' => array('type' => 'text', 'description' => 'session data'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('id'), + 'indexes' => array( + 'session_modified_idx' => array('modified'), + ), + ); + } + static function logdeb($msg) { if (common_config('sessions', 'debug')) { diff --git a/classes/Sms_carrier.php b/classes/Sms_carrier.php index 500cb4f043..08d83f08f2 100644 --- a/classes/Sms_carrier.php +++ b/classes/Sms_carrier.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Sms_carrier extends Memcached_DataObject +class Sms_carrier extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -27,4 +27,21 @@ class Sms_carrier extends Memcached_DataObject { return sprintf($this->email_pattern, $sms); } + + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'int', 'not null' => true, 'description' => 'primary key for SMS carrier'), + 'name' => array('type' => 'varchar', 'length' => 64, 'description' => 'name of the carrier'), + 'email_pattern' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'sprintf pattern for making an email address from a phone number'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('id'), + 'unique keys' => array( + 'sms_carrier_name_key' => array('name'), + ), + ); + } } diff --git a/classes/Subscription.php b/classes/Subscription.php index e83621eb86..f40239989c 100644 --- a/classes/Subscription.php +++ b/classes/Subscription.php @@ -24,7 +24,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Subscription extends Memcached_DataObject +class Subscription extends Managed_DataObject { const CACHE_WINDOW = 201; const FORCE = true; @@ -39,9 +39,36 @@ class Subscription extends Memcached_DataObject public $sms; // tinyint(1) default_1 public $token; // varchar(255) public $secret; // varchar(255) + public $uri; // varchar(255) public $created; // datetime() not_null public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP + public static function schemaDef() + { + return array( + 'fields' => array( + 'subscriber' => array('type' => 'int', 'not null' => true, 'description' => 'profile listening'), + 'subscribed' => array('type' => 'int', 'not null' => true, 'description' => 'profile being listened to'), + 'jabber' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'deliver jabber messages'), + 'sms' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'deliver sms messages'), + 'token' => array('type' => 'varchar', 'length' => 255, 'description' => 'authorization token'), + 'secret' => array('type' => 'varchar', 'length' => 255, 'description' => 'token secret'), + 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('subscriber', 'subscribed'), + 'unique keys' => array( + 'subscription_uri_key' => array('uri'), + ), + 'indexes' => array( + 'subscription_subscriber_idx' => array('subscriber', 'created'), + 'subscription_subscribed_idx' => array('subscribed', 'created'), + 'subscription_token_idx' => array('token'), + ), + ); + } + /* Static get */ function staticGet($k,$v=null) { return Memcached_DataObject::staticGet('Subscription',$k,$v); } @@ -138,6 +165,9 @@ class Subscription extends Memcached_DataObject $sub->jabber = 1; $sub->sms = 1; $sub->created = common_sql_now(); + $sub->uri = self::newURI($sub->subscriber, + $sub->subscribed, + $sub->created); $result = $sub->insert(); @@ -238,10 +268,7 @@ class Subscription extends Memcached_DataObject // XXX: rationalize this with the URL - $act->id = TagURI::mint('follow:%d:%d:%s', - $subscriber->id, - $subscribed->id, - common_date_iso8601($this->created)); + $act->id = $this->getURI(); $act->time = strtotime($this->created); // TRANS: Activity title when subscribing to another person. @@ -404,4 +431,21 @@ class Subscription extends Memcached_DataObject return $result; } + + function getURI() + { + if (!empty($this->uri)) { + return $this->uri; + } else { + return self::newURI($this->subscriber, $this->subscribed, $this->created); + } + } + + static function newURI($subscriber_id, $subscribed_id, $created) + { + return TagURI::mint('follow:%d:%d:%s', + $subscriber_id, + $subscribed_id, + common_date_iso8601($created)); + } } diff --git a/classes/Token.php b/classes/Token.php index a129d1fd11..8a6b46bbbb 100644 --- a/classes/Token.php +++ b/classes/Token.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class Token extends Memcached_DataObject +class Token extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -26,4 +26,26 @@ class Token extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'description' => 'OAuth token record', + 'fields' => array( + 'consumer_key' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'unique identifier, root URL'), + 'tok' => array('type' => 'char', 'length' => 32, 'not null' => true, 'description' => 'identifying value'), + 'secret' => array('type' => 'char', 'length' => 32, 'not null' => true, 'description' => 'secret value'), + 'type' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 0, 'description' => 'request or access'), + 'state' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'for requests, 0 = initial, 1 = authorized, 2 = used'), + 'verifier' => array('type' => 'varchar', 'length' => 255, 'description' => 'verifier string for OAuth 1.0a'), + 'verified_callback' => array('type' => 'varchar', 'length' => 255, 'description' => 'verified callback URL for OAuth 1.0a'), + + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('consumer_key', 'tok'), + 'foreign keys' => array( + 'token_consumer_key_fkey' => array('consumer', array('consumer_key'=> 'consumer_key')), + ), + ); + } } diff --git a/classes/User.php b/classes/User.php index d15c2c0ae6..93340f021d 100644 --- a/classes/User.php +++ b/classes/User.php @@ -28,7 +28,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; require_once 'Validate.php'; -class User extends Memcached_DataObject +class User extends Managed_DataObject { const SUBSCRIBE_POLICY_OPEN = 0; const SUBSCRIBE_POLICY_MODERATE = 1; @@ -71,6 +71,58 @@ class User extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'description' => 'local users', + 'fields' => array( + 'id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), + 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname or username, duped in profile'), + 'password' => array('type' => 'varchar', 'length' => 255, 'description' => 'salted password, can be null for OpenID users'), + 'email' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for password recovery etc.'), + 'incomingemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for post-by-email'), + 'emailnotifysub' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of subscriptions'), + 'emailnotifyfav' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of favorites'), + 'emailnotifynudge' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of nudges'), + 'emailnotifymsg' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of direct messages'), + 'emailnotifyattn' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of @-replies'), + 'emailmicroid' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'whether to publish email microid'), + 'language' => array('type' => 'varchar', 'length' => 50, 'description' => 'preferred language'), + 'timezone' => array('type' => 'varchar', 'length' => 50, 'description' => 'timezone'), + 'emailpost' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Post by email'), + 'sms' => array('type' => 'varchar', 'length' => 64, 'description' => 'sms phone number'), + 'carrier' => array('type' => 'int', 'description' => 'foreign key to sms_carrier'), + 'smsnotify' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS'), + 'smsreplies' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS on replies'), + 'smsemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'built from sms and carrier'), + 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'), + 'autosubscribe' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'automatically subscribe to users who subscribe to us'), + 'subscribe_policy' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => '0 = anybody can subscribe; 1 = require approval'), + 'urlshorteningservice' => array('type' => 'varchar', 'length' => 50, 'default' => 'internal', 'description' => 'service to use for auto-shortening URLs'), + 'inboxed' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'has an inbox been created for this user?'), + 'private_stream' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to limit all notices to followers only'), + + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('id'), + 'unique keys' => array( + 'user_nickname_key' => array('nickname'), + 'user_email_key' => array('email'), + 'user_incomingemail_key' => array('incomingemail'), + 'user_sms_key' => array('sms'), + 'user_uri_key' => array('uri'), + ), + 'foreign keys' => array( + 'user_id_fkey' => array('profile', array('id' => 'id')), + 'user_carrier_fkey' => array('sms_carrier', array('carrier' => 'id')), + ), + 'indexes' => array( + 'user_smsemail_idx' => array('smsemail'), + ), + ); + } + protected $_profile = -1; /** diff --git a/classes/User_group.php b/classes/User_group.php index 38cc5603db..4870e39a15 100644 --- a/classes/User_group.php +++ b/classes/User_group.php @@ -3,7 +3,7 @@ * Table Definition for user_group */ -class User_group extends Memcached_DataObject +class User_group extends Managed_DataObject { const JOIN_POLICY_OPEN = 0; const JOIN_POLICY_MODERATE = 1; @@ -42,6 +42,41 @@ class User_group extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), + + 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname for addressing'), + 'fullname' => array('type' => 'varchar', 'length' => 255, 'description' => 'display name'), + 'homepage' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL, cached so we dont regenerate'), + 'description' => array('type' => 'text', 'description' => 'group description'), + 'location' => array('type' => 'varchar', 'length' => 255, 'description' => 'related physical location, if any'), + + 'original_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'original size logo'), + 'homepage_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'homepage (profile) size logo'), + 'stream_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'stream-sized logo'), + 'mini_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'mini logo'), + + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + + 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universal identifier'), + 'mainpage' => array('type' => 'varchar', 'length' => 255, 'description' => 'page for group info to link to'), + 'join_policy' => array('type' => 'int', 'size' => 'tiny', 'description' => '0=open; 1=requires admin approval'), + 'force_scope' => array('type' => 'int', 'size' => 'tiny', 'description' => '0=never,1=sometimes,-1=always'), + ), + 'primary key' => array('id'), + 'unique keys' => array( + 'user_group_uri_key' => array('uri'), + ), + 'indexes' => array( + 'user_group_nickname_idx' => array('nickname'), + ), + ); + } + function defaultLogo($size) { static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile', @@ -494,6 +529,18 @@ class User_group extends Memcached_DataObject // MAGICALLY put fields into current scope // @fixme kill extract(); it makes debugging absurdly hard + $defaults = array('nickname' => null, + 'fullname' => null, + 'homepage' => null, + 'description' => null, + 'location' => null, + 'uri' => null, + 'mainpage' => null, + 'aliases' => array(), + 'userid' => null); + + $fields = array_merge($defaults, $fields); + extract($fields); $group = new User_group(); diff --git a/classes/User_im_prefs.php b/classes/User_im_prefs.php index 75be8969e0..cc9dea608d 100644 --- a/classes/User_im_prefs.php +++ b/classes/User_im_prefs.php @@ -29,7 +29,7 @@ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class User_im_prefs extends Memcached_DataObject +class User_im_prefs extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -56,17 +56,28 @@ class User_im_prefs extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE - /* - DB_DataObject calculates the sequence key(s) by taking the first key returned by the keys() function. - In this case, the keys() function returns user_id as the first key. user_id is not a sequence, but - DB_DataObject's sequenceKey() will incorrectly think it is. Then, since the sequenceKey() is a numeric - type, but is not set to autoincrement in the database, DB_DataObject will create a _seq table and - manage the sequence itself. This is not the correct behavior for the user_id in this class. - So we override that incorrect behavior, and simply say there is no sequence key. - */ - function sequenceKey() + public static function schemaDef() { - return array(false,false); + return array( + 'fields' => array( + 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user'), + 'screenname' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'screenname on this service'), + 'transport' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'transport (ex xmpp, aim)'), + 'notify' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 0, 'description' => 'Notify when a new notice is sent'), + 'replies' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 0, 'description' => 'Send replies from people not subscribed to'), + 'microid' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 1, 'description' => 'Publish a MicroID'), + 'updatefrompresence' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 0, 'description' => 'Send replies from people not subscribed to.'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('user_id', 'transport'), + 'unique keys' => array( + 'transport_screenname_key' => array('transport', 'screenname'), + ), + 'foreign keys' => array( + 'user_im_prefs_user_id_fkey' => array('user', array('user_id' => 'id')), + ), + ); } /** diff --git a/classes/User_location_prefs.php b/classes/User_location_prefs.php index bd6029f97c..060ef41e83 100644 --- a/classes/User_location_prefs.php +++ b/classes/User_location_prefs.php @@ -29,7 +29,7 @@ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class User_location_prefs extends Memcached_DataObject +class User_location_prefs extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -46,8 +46,19 @@ class User_location_prefs extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE - function sequenceKey() + public static function schemaDef() { - return array(false, false, false); + return array( + 'fields' => array( + 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who has the preference'), + 'share_location' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Whether to share location data'), + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('user_id'), + 'foreign keys' => array( + 'user_location_prefs_user_id_fkey' => array('user', array('user_id' => 'id')), + ), + ); } } diff --git a/classes/User_urlshortener_prefs.php b/classes/User_urlshortener_prefs.php index e0f85af012..f71adc9736 100755 --- a/classes/User_urlshortener_prefs.php +++ b/classes/User_urlshortener_prefs.php @@ -21,7 +21,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } -class User_urlshortener_prefs extends Memcached_DataObject +class User_urlshortener_prefs extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ @@ -40,9 +40,23 @@ class User_urlshortener_prefs extends Memcached_DataObject /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE - function sequenceKey() + public static function schemaDef() { - return array(false, false, false); + return array( + 'fields' => array( + 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user'), + 'urlshorteningservice' => array('type' => 'varchar', 'length' => 50, 'default' => 'internal', 'description' => 'service to use for auto-shortening URLs'), + 'maxurllength' => array('type' => 'int', 'not null' => true, 'description' => 'urls greater than this length will be shortened, 0 = always, null = never'), + 'maxnoticelength' => array('type' => 'int', 'not null' => true, 'description' => 'notices with content greater than this value will have all urls shortened, 0 = always, null = never'), + + 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), + 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), + ), + 'primary key' => array('user_id'), + 'foreign keys' => array( + 'user_urlshortener_prefs_user_id_fkey' => array('user', array('user_id' => 'id')), + ), + ); } static function maxUrlLength($user) diff --git a/classes/User_username.php b/classes/User_username.php index ae7785cc9f..652e7bd141 100644 --- a/classes/User_username.php +++ b/classes/User_username.php @@ -4,7 +4,7 @@ */ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; -class User_username extends Memcached_DataObject +class User_username extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ diff --git a/classes/statusnet.ini b/classes/statusnet.ini deleted file mode 100644 index c5c126a133..0000000000 --- a/classes/statusnet.ini +++ /dev/null @@ -1,720 +0,0 @@ -[avatar] -profile_id = 129 -original = 17 -width = 129 -height = 129 -mediatype = 130 -filename = 2 -url = 2 -created = 142 -modified = 384 - -[avatar__keys] -profile_id = K -width = K -height = K -url = U - -[config] -section = 130 -setting = 130 -value = 2 - -[config__keys] -section = K -setting = K - -[confirm_address] -code = 130 -user_id = 129 -address = 130 -address_extra = 130 -address_type = 130 -claimed = 14 -sent = 14 -modified = 384 - -[confirm_address__keys] -code = K - -[consumer] -consumer_key = 130 -consumer_secret = 130 -seed = 130 -created = 142 -modified = 384 - -[consumer__keys] -consumer_key = K - -[conversation] -id = 129 -uri = 2 -created = 142 -modified = 384 - -[conversation__keys] -id = N -uri = U - -[deleted_notice] -id = 129 -profile_id = 129 -uri = 2 -created = 142 -deleted = 142 - -[deleted_notice__keys] -id = K -uri = U - -[design] -id = 129 -backgroundcolor = 1 -contentcolor = 1 -sidebarcolor = 1 -textcolor = 1 -linkcolor = 1 -backgroundimage = 2 -disposition = 17 - -[design__keys] -id = N - -[fave] -notice_id = 129 -user_id = 129 -modified = 384 - -[fave__keys] -notice_id = K -user_id = K - -[file] -id = 129 -url = 2 -mimetype = 2 -size = 1 -title = 2 -date = 1 -protected = 1 -filename = 2 -modified = 384 - -[file__keys] -id = N -url = U - -[file_oembed] -file_id = 129 -version = 2 -type = 2 -mimetype = 2 -provider = 2 -provider_url = 2 -width = 1 -height = 1 -html = 34 -title = 2 -author_name = 2 -author_url = 2 -url = 2 -modified = 384 - -[file_oembed__keys] -file_id = K - -[file_redirection] -url = 130 -file_id = 1 -redirections = 1 -httpcode = 1 -modified = 384 - -[file_redirection__keys] -url = K - -[file_thumbnail] -file_id = 129 -url = 2 -width = 1 -height = 1 -modified = 384 - -[file_thumbnail__keys] -file_id = K -url = U - -[file_to_post] -file_id = 129 -post_id = 129 -modified = 384 - -[file_to_post__keys] -file_id = K -post_id = K - -[foreign_link] -user_id = 129 -foreign_id = 129 -service = 129 -credentials = 2 -noticesync = 145 -friendsync = 145 -profilesync = 145 -last_noticesync = 14 -last_friendsync = 14 -created = 142 -modified = 384 - -[foreign_link__keys] -user_id = K -foreign_id = K -service = K - -[foreign_service] -id = 129 -name = 130 -description = 2 -created = 142 -modified = 384 - -[foreign_service__keys] -id = K -name = U - -[foreign_subscription] -service = 129 -subscriber = 129 -subscribed = 129 -created = 142 - -[foreign_subscription__keys] -service = K -subscriber = K -subscribed = K - -[foreign_user] -id = 129 -service = 129 -uri = 130 -nickname = 2 -created = 142 -modified = 384 - -[foreign_user__keys] -id = K -service = K -uri = U - -[group_alias] -alias = 130 -group_id = 129 -modified = 384 - -[group_alias__keys] -alias = K - -[group_block] -group_id = 129 -blocked = 129 -blocker = 129 -modified = 384 - -[group_block__keys] -group_id = K -blocked = K - -[group_inbox] -group_id = 129 -notice_id = 129 -created = 142 - -[group_inbox__keys] -group_id = K -notice_id = K - -[group_member] -group_id = 129 -profile_id = 129 -is_admin = 17 -created = 142 -modified = 384 - -[group_member__keys] -group_id = K -profile_id = K - -[inbox] -user_id = 129 -notice_ids = 66 - -[inbox__keys] -user_id = K - -[invitation] -code = 130 -user_id = 129 -address = 130 -address_type = 130 -created = 142 -registered_user_id = 1 - -[invitation__keys] -code = K - -[local_group] -group_id = 129 -nickname = 2 -created = 142 -modified = 384 - -[local_group__keys] -group_id = K -nickname = U - -[location_namespace] -id = 129 -description = 2 -created = 142 -modified = 384 - -[location_namespace__keys] -id = K - -[login_token] -user_id = 129 -token = 130 -created = 142 -modified = 384 - -[login_token__keys] -user_id = K - -[message] -id = 129 -uri = 2 -from_profile = 129 -to_profile = 129 -content = 34 -rendered = 34 -url = 2 -created = 142 -modified = 384 -source = 2 - -[message__keys] -id = N - -[nonce] -consumer_key = 130 -tok = 2 -nonce = 130 -ts = 142 -created = 142 -modified = 384 - -[nonce__keys] -consumer_key = K -nonce = K -ts = K - -[notice] -id = 129 -profile_id = 129 -uri = 2 -content = 34 -rendered = 34 -url = 2 -created = 142 -modified = 384 -reply_to = 1 -is_local = 17 -source = 2 -conversation = 1 -lat = 1 -lon = 1 -location_id = 1 -location_ns = 1 -repeat_of = 1 -object_type = 2 -scope = 1 - -[notice__keys] -id = N - -[notice_inbox] -user_id = 129 -notice_id = 129 -created = 142 -source = 17 - -[notice_inbox__keys] -user_id = K -notice_id = K - -[notice_source] -code = 130 -name = 130 -url = 130 -created = 142 -modified = 384 - -[notice_source__keys] -code = K - -[notice_tag] -tag = 130 -notice_id = 129 -created = 142 - -[notice_tag__keys] -tag = K -notice_id = K - -[oauth_application] -id = 129 -owner = 129 -consumer_key = 130 -name = 130 -description = 2 -icon = 130 -source_url = 2 -organization = 2 -homepage = 2 -callback_url = 2 -type = 17 -access_type = 17 -created = 142 -modified = 384 - -[oauth_application__keys] -id = N -name = U - -[oauth_application_user] -profile_id = 129 -application_id = 129 -access_type = 17 -token = 2 -created = 142 -modified = 384 - -[oauth_application_user__keys] -profile_id = K -application_id = K - -[oauth_token_association] -profile_id = 129 -application_id = 129 -token = 130 -created = 142 -modified = 384 - -[oauth_token_association__keys] -profile_id = K -application_id = K -token = K - -[profile] -id = 129 -nickname = 130 -fullname = 2 -profileurl = 2 -homepage = 2 -bio = 34 -location = 2 -lat = 1 -lon = 1 -location_id = 1 -location_ns = 1 -created = 142 -modified = 384 - -[profile__keys] -id = N - -[profile_block] -blocker = 129 -blocked = 129 -modified = 384 - -[profile_block__keys] -blocker = K -blocked = K - -[profile_role] -profile_id = 129 -role = 130 -created = 142 - -[profile_role__keys] -profile_id = K -role = K - -[profile_tag] -tagger = 129 -tagged = 129 -tag = 130 -modified = 384 - -[profile_tag__keys] -tagger = K -tagged = K -tag = K - -[profile_list] -id = 129 -tagger = 129 -tag = 130 -description = 34 -private = 17 -created = 142 -modified = 384 -uri = 130 -mainpage = 130 -tagged_count = 129 -subscriber_count = 129 - -[profile_list__keys] -id = U -tagger = K -tag = K - -[profile_tag_subscription] -profile_tag_id = 129 -profile_id = 129 -created = 142 -modified = 384 - -[profile_tag_subscription__keys] -profile_tag_id = K -profile_id = K - -[queue_item] -id = 129 -frame = 194 -transport = 130 -created = 142 -claimed = 14 - -[queue_item__keys] -id = N - -[related_group] -group_id = 129 -related_group_id = 129 -created = 142 - -[related_group__keys] -group_id = K -related_group_id = K - -[remember_me] -code = 130 -user_id = 129 -modified = 384 - -[remember_me__keys] -code = K - -[remote_profile] -id = 129 -uri = 2 -postnoticeurl = 2 -updateprofileurl = 2 -created = 142 -modified = 384 - -[remote_profile__keys] -id = K -uri = U - -[reply] -notice_id = 129 -profile_id = 129 -modified = 142 -;modified = 384 ; skipping the mysql_timestamp mode so we can override its setting -replied_id = 1 - -[reply__keys] -notice_id = K -profile_id = K - -[schema_version] -table_name = 130 -checksum = 130 -modified = 384 - -[schema_version__keys] -table_name = K - -[session] -id = 130 -session_data = 34 -created = 142 -modified = 384 - -[session__keys] -id = K - -[sms_carrier] -id = 129 -name = 2 -email_pattern = 130 -created = 142 -modified = 384 - -[sms_carrier__keys] -id = K -name = U - -[subscription] -subscriber = 129 -subscribed = 129 -jabber = 17 -sms = 17 -token = 2 -secret = 2 -created = 142 -modified = 384 - -[subscription__keys] -subscriber = K -subscribed = K - -[token] -consumer_key = 130 -tok = 130 -secret = 130 -type = 145 -state = 17 -verifier = 2 -verified_callback = 2 -created = 142 -modified = 384 - -[token__keys] -consumer_key = K -tok = K - -[user] -id = 129 -nickname = 2 -password = 2 -email = 2 -incomingemail = 2 -emailnotifysub = 17 -emailnotifyfav = 17 -emailnotifynudge = 17 -emailnotifymsg = 17 -emailnotifyattn = 17 -emailmicroid = 17 -language = 2 -timezone = 2 -emailpost = 17 -sms = 2 -carrier = 1 -smsnotify = 17 -smsreplies = 17 -smsemail = 2 -uri = 2 -autosubscribe = 17 -subscribe_policy = 17 -urlshorteningservice = 2 -inboxed = 17 -design_id = 1 -viewdesigns = 17 -private_stream = 17 -created = 142 -modified = 384 - -[user__keys] -id = K -nickname = U -email = U -incomingemail = U -sms = U -uri = U - -[user_group] -id = 129 -nickname = 2 -fullname = 2 -homepage = 2 -description = 34 -location = 2 -original_logo = 2 -homepage_logo = 2 -stream_logo = 2 -mini_logo = 2 -design_id = 1 -created = 142 -modified = 384 -uri = 2 -mainpage = 2 -join_policy = 1 -force_scope = 1 - -[user_group__keys] -id = N - -[user_openid] -canonical = 130 -display = 130 -user_id = 129 -created = 142 -modified = 384 - -[user_openid__keys] -canonical = K -display = U - -[user_openid_trustroot] -trustroot = 130 -user_id = 129 -created = 142 -modified = 384 - -[user_openid__keys] -trustroot = K -user_id = K - -[user_location_prefs] -user_id = 129 -share_location = 17 -created = 142 -modified = 384 - -[user_location_prefs__keys] -user_id = K - -[user_im_prefs] -user_id = 129 -screenname = 130 -transport = 130 -notify = 17 -replies = 17 -microid = 17 -updatefrompresence = 17 -created = 142 -modified = 384 - -[user_im_prefs__keys] -user_id = K -transport = K -; There's another unique index on (transport, screenname) -; but we have no way to represent a compound index other than -; the primary key in here. To ensure proper cache purging, -; we need to tweak the class. - -[user_urlshortener_prefs] -user_id = 129 -urlshorteningservice = 2 -maxurllength = 129 -maxnoticelength = 129 -created = 142 -modified = 384 - -[user_urlshortener_prefs__keys] -user_id = K diff --git a/classes/statusnet.links.ini b/classes/statusnet.links.ini deleted file mode 100644 index 17a8c40085..0000000000 --- a/classes/statusnet.links.ini +++ /dev/null @@ -1,74 +0,0 @@ -[avatar] -profile_id = profile:id - -[user] -id = profile:id -carrier = sms_carrier:id - -[remote_profile] -id = profile:id - -[notice] -profile_id = profile:id -reply_to = notice:id -profile_id = profile_tag:tagged - -[reply] -notice_id = notice:id -profile_id = profile:id - -[token] -consumer_key = consumer:consumer_key - -; Compatibility hack for PHP 5.3 -; This entry has been moved to the class definition, as commas are no longer -; considered valid in keys, causing parse_ini_file() to reject the whole file. -;[nonce] -;consumer_key,token = token:consumer_key,token - -[confirm_address] -user_id = user:id - -[remember_me] -user_id = user:id - -[queue_item] -notice_id = notice:id - -[subscription] -subscriber = profile:id -subscribed = profile:id - -[fave] -notice_id = notice:id -user_id = user:id - -[file_oembed] -file_id = file:id - -[file_redirection] -file_id = file:id - -[file_thumbnail] -file_id = file:id - -[file_to_post] -file_id = file:id -post_id = notice:id - -[profile_list] -tagger = profile:id - -[profile_tag] -tagger = profile:id -tagged = profile:id -; in class definition: -;tag,tagger = profile_list:tag,tagger - -[profile_list] -tagger = profile:id - -[profile_tag_subscription] -profile_tag_id = profile_list:id -profile_id = profile:id - diff --git a/db/074to080.sql b/db/074to080.sql deleted file mode 100644 index e3631e214a..0000000000 --- a/db/074to080.sql +++ /dev/null @@ -1,121 +0,0 @@ -alter table user - add column design_id integer comment 'id of a design' references design(id), - add column viewdesigns tinyint default 1 comment 'whether to view user-provided designs'; - -alter table notice add column - conversation integer comment 'id of root notice in this conversation' references notice (id), - add index notice_conversation_idx (conversation); - -alter table foreign_user - modify column id bigint not null comment 'unique numeric key on foreign service'; - -alter table foreign_link - modify column foreign_id bigint unsigned comment 'link to user on foreign service, if exists'; - -alter table user_group - add column design_id integer comment 'id of a design' references design(id); - -create table file ( - id integer primary key auto_increment, - url varchar(255) comment 'destination URL after following redirections', - mimetype varchar(50) comment 'mime type of resource', - size integer comment 'size of resource when available', - title varchar(255) comment 'title of resource when available', - date integer(11) comment 'date of resource according to http query', - protected integer(1) comment 'true when URL is private (needs login)', - filename varchar(255) comment 'if a local file, name of the file', - modified timestamp comment 'date this record was modified', - - unique(url) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_general_ci; - -create table file_oembed ( - file_id integer primary key comment 'oEmbed for that URL/file' references file (id), - version varchar(20) comment 'oEmbed spec. version', - type varchar(20) comment 'oEmbed type: photo, video, link, rich', - provider varchar(50) comment 'name of this oEmbed provider', - provider_url varchar(255) comment 'URL of this oEmbed provider', - width integer comment 'width of oEmbed resource when available', - height integer comment 'height of oEmbed resource when available', - html text comment 'html representation of this oEmbed resource when applicable', - title varchar(255) comment 'title of oEmbed resource when available', - author_name varchar(50) comment 'author name for this oEmbed resource', - author_url varchar(255) comment 'author URL for this oEmbed resource', - url varchar(255) comment 'URL for this oEmbed resource when applicable (photo, link)', - modified timestamp comment 'date this record was modified' - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_general_ci; - -create table file_redirection ( - - url varchar(255) primary key comment 'short URL (or any other kind of redirect) for file (id)', - file_id integer comment 'short URL for what URL/file' references file (id), - redirections integer comment 'redirect count', - httpcode integer comment 'HTTP status code (20x, 30x, etc.)', - modified timestamp comment 'date this record was modified' - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table file_thumbnail ( - - file_id integer primary key comment 'thumbnail for what URL/file' references file (id), - url varchar(255) comment 'URL of thumbnail', - width integer comment 'width of thumbnail', - height integer comment 'height of thumbnail', - modified timestamp comment 'date this record was modified', - - unique(url) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table file_to_post ( - - file_id integer comment 'id of URL/file' references file (id), - post_id integer comment 'id of the notice it belongs to' references notice (id), - modified timestamp comment 'date this record was modified', - - constraint primary key (file_id, post_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table design ( - id integer primary key auto_increment comment 'design ID', - backgroundcolor integer comment 'main background color', - contentcolor integer comment 'content area background color', - sidebarcolor integer comment 'sidebar background color', - textcolor integer comment 'text color', - linkcolor integer comment 'link color', - backgroundimage varchar(255) comment 'background image, if any', - disposition tinyint default 1 comment 'bit 1 = hide background image, bit 2 = display background image, bit 4 = tile background image' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table group_block ( - group_id integer not null comment 'group profile is blocked from' references user_group (id), - blocked integer not null comment 'profile that is blocked' references profile (id), - blocker integer not null comment 'user making the block' references user (id), - modified timestamp comment 'date of blocking', - - constraint primary key (group_id, blocked) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table group_alias ( - - alias varchar(64) primary key comment 'additional nickname for the group', - group_id integer not null comment 'group profile is blocked from' references user_group (id), - modified timestamp comment 'date alias was created', - - index group_alias_group_id_idx (group_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table session ( - - id varchar(32) primary key comment 'session ID', - session_data text comment 'session data', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - index session_modified_idx (modified) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - diff --git a/db/074to080_pg.sql b/db/074to080_pg.sql deleted file mode 100644 index 0a7171ae56..0000000000 --- a/db/074to080_pg.sql +++ /dev/null @@ -1,108 +0,0 @@ -BEGIN; -create sequence design_seq; -create table design ( - id bigint default nextval('design_seq') /* comment 'design ID'*/, - backgroundcolor integer /* comment 'main background color'*/ , - contentcolor integer /*comment 'content area background color'*/ , - sidebarcolor integer /*comment 'sidebar background color'*/ , - textcolor integer /*comment 'text color'*/ , - linkcolor integer /*comment 'link color'*/, - backgroundimage varchar(255) /*comment 'background image, if any'*/, - disposition int default 1 /*comment 'bit 1 = hide background image, bit 2 = display background image, bit 4 = tile background image'*/, - primary key (id) -); -alter table "user" - add column design_id integer references design(id); -alter table "user" - add column viewdesigns integer default 1; - -alter table notice add column - conversation integer references notice (id); - -create index notice_conversation_idx on notice(conversation); - -alter table foreign_user - alter column id TYPE bigint; - -alter table foreign_user alter column id set not null; - -alter table foreign_link - alter column foreign_id TYPE bigint; - -alter table user_group - add column design_id integer; - -/*attachments and URLs stuff */ -create sequence file_seq; -create table file ( - id bigint default nextval('file_seq') primary key /* comment 'unique identifier' */, - url varchar(255) unique, - mimetype varchar(50), - size integer, - title varchar(255), - date integer, - protected integer, - filename text /* comment 'if a local file, name of the file' */, - modified timestamp default CURRENT_TIMESTAMP /* comment 'date this record was modified'*/ -); - -create sequence file_oembed_seq; -create table file_oembed ( - file_id bigint default nextval('file_oembed_seq') primary key /* comment 'unique identifier' */, - version varchar(20), - type varchar(20), - provider varchar(50), - provider_url varchar(255), - width integer, - height integer, - html text, - title varchar(255), - author_name varchar(50), - author_url varchar(255), - url varchar(255) -); - -create sequence file_redirection_seq; -create table file_redirection ( - url varchar(255) primary key, - file_id bigint, - redirections integer, - httpcode integer -); - -create sequence file_thumbnail_seq; -create table file_thumbnail ( - file_id bigint primary key, - url varchar(255) unique, - width integer, - height integer -); -create sequence file_to_post_seq; -create table file_to_post ( - file_id bigint, - post_id bigint, - - primary key (file_id, post_id) -); - - -create table group_block ( - group_id integer not null /* comment 'group profile is blocked from' */ references user_group (id), - blocked integer not null /* comment 'profile that is blocked' */references profile (id), - blocker integer not null /* comment 'user making the block'*/ references "user" (id), - modified timestamp /* comment 'date of blocking'*/ , - - primary key (group_id, blocked) -); - -create table group_alias ( - - alias varchar(64) /* comment 'additional nickname for the group'*/ , - group_id integer not null /* comment 'group profile is blocked from'*/ references user_group (id), - modified timestamp /* comment 'date alias was created'*/, - primary key (alias) - -); -create index group_alias_group_id_idx on group_alias (group_id); - -COMMIT; \ No newline at end of file diff --git a/db/08to09.sql b/db/08to09.sql deleted file mode 100644 index ba6f382005..0000000000 --- a/db/08to09.sql +++ /dev/null @@ -1,190 +0,0 @@ -alter table notice - modify column content text comment 'update content', - add column lat decimal(10,7) comment 'latitude', - add column lon decimal(10,7) comment 'longitude', - add column location_id integer comment 'location id if possible', - add column location_ns integer comment 'namespace for location', - add column repeat_of integer comment 'notice this is a repeat of' references notice (id), - drop index notice_profile_id_idx, - add index notice_profile_id_idx (profile_id,created,id), - add index notice_repeatof_idx (repeat_of); - -alter table message - modify column content text comment 'message content'; - -alter table profile - modify column bio text comment 'descriptive biography', - add column lat decimal(10,7) comment 'latitude', - add column lon decimal(10,7) comment 'longitude', - add column location_id integer comment 'location id if possible', - add column location_ns integer comment 'namespace for location'; - -alter table user_group - modify column description text comment 'group description'; - -alter table file_oembed - add column mimetype varchar(50) comment 'mime type of resource'; - -alter table fave - drop index fave_user_id_idx, - add index fave_user_id_idx (user_id,modified); - -alter table subscription - drop index subscription_subscriber_idx, - add index subscription_subscriber_idx (subscriber,created), - drop index subscription_subscribed_idx, - add index subscription_subscribed_idx (subscribed,created); - -create table deleted_notice ( - - id integer primary key comment 'identity of notice', - profile_id integer not null comment 'author of the notice', - uri varchar(255) unique key comment 'universally unique identifier, usually a tag URI', - created datetime not null comment 'date the notice record was created', - deleted datetime not null comment 'date the notice record was created', - - index deleted_notice_profile_id_idx (profile_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table config ( - - section varchar(32) comment 'configuration section', - setting varchar(32) comment 'configuration setting', - value varchar(255) comment 'configuration value', - - constraint primary key (section, setting) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table profile_role ( - - profile_id integer not null comment 'account having the role' references profile (id), - role varchar(32) not null comment 'string representing the role', - created datetime not null comment 'date the role was granted', - - constraint primary key (profile_id, role) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table location_namespace ( - - id integer primary key comment 'identity for this namespace', - description varchar(255) comment 'description of the namespace', - created datetime not null comment 'date the record was created', - modified timestamp comment 'date this record was modified' - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table login_token ( - user_id integer not null comment 'user owning this token' references user (id), - token char(32) not null comment 'token useable for logging in', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (user_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table user_location_prefs ( - user_id integer not null comment 'user who has the preference' references user (id), - share_location tinyint default 1 comment 'Whether to share location data', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (user_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table queue_item_new ( - id integer auto_increment primary key comment 'unique identifier', - frame blob not null comment 'data: object reference or opaque string', - transport varchar(8) not null comment 'queue for what? "email", "jabber", "sms", "irc", ...', - created datetime not null comment 'date this record was created', - claimed datetime comment 'date this item was claimed', - - index queue_item_created_idx (created) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -insert into queue_item_new (frame,transport,created,claimed) - select notice_id,transport,created,claimed from queue_item; -alter table queue_item rename to queue_item_old; -alter table queue_item_new rename to queue_item; - -alter table consumer - add consumer_secret varchar(255) not null comment 'secret value'; - -alter table token - add verifier varchar(255) comment 'verifier string for OAuth 1.0a', - add verified_callback varchar(255) comment 'verified callback URL for OAuth 1.0a'; - -create table oauth_application ( - id integer auto_increment primary key comment 'unique identifier', - owner integer not null comment 'owner of the application' references profile (id), - consumer_key varchar(255) not null comment 'application consumer key' references consumer (consumer_key), - name varchar(255) not null comment 'name of the application', - description varchar(255) comment 'description of the application', - icon varchar(255) not null comment 'application icon', - source_url varchar(255) comment 'application homepage - used for source link', - organization varchar(255) comment 'name of the organization running the application', - homepage varchar(255) comment 'homepage for the organization', - callback_url varchar(255) comment 'url to redirect to after authentication', - type tinyint default 0 comment 'type of app, 1 = browser, 2 = desktop', - access_type tinyint default 0 comment 'default access type, bit 1 = read, bit 2 = write', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table oauth_application_user ( - profile_id integer not null comment 'user of the application' references profile (id), - application_id integer not null comment 'id of the application' references oauth_application (id), - access_type tinyint default 0 comment 'access type, bit 1 = read, bit 2 = write, bit 3 = revoked', - token varchar(255) comment 'request or access token', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - constraint primary key (profile_id, application_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table inbox ( - - user_id integer not null comment 'user receiving the notice' references user (id), - notice_ids blob comment 'packed list of notice ids', - - constraint primary key (user_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table conversation ( - id integer auto_increment primary key comment 'unique identifier', - uri varchar(225) unique comment 'URI of the conversation', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - --- stub entry to push the autoincrement past existing notice ids -insert into conversation (id,created) - select max(id)+1, now() from notice; - -alter table user_group - add uri varchar(255) unique key comment 'universal identifier', - add mainpage varchar(255) comment 'page for group info to link to', - drop index nickname; - -create table local_group ( - - group_id integer primary key comment 'group represented' references user_group (id), - nickname varchar(64) unique key comment 'group represented', - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -insert into local_group (group_id, nickname, created) - select id, nickname, created from user_group; - -alter table file_to_post - add index post_id_idx (post_id); - -alter table group_inbox - add index group_inbox_notice_id_idx (notice_id); - diff --git a/db/08to09_pg.sql b/db/08to09_pg.sql deleted file mode 100644 index d3eb644437..0000000000 --- a/db/08to09_pg.sql +++ /dev/null @@ -1,140 +0,0 @@ --- SQL commands to update an 0.8.x version of Laconica --- to 0.9.x. - ---these are just comments -/* -alter table notice - modify column content text comment 'update content'; - -alter table message - modify column content text comment 'message content'; - -alter table profile - modify column bio text comment 'descriptive biography'; - -alter table user_group - modify column description text comment 'group description'; -*/ - -alter table file_oembed - add column mimetype varchar(50) /*comment 'mime type of resource'*/; - -create table config ( - - section varchar(32) /* comment 'configuration section'*/, - setting varchar(32) /* comment 'configuration setting'*/, - value varchar(255) /* comment 'configuration value'*/, - - primary key (section, setting) - -); - -create table profile_role ( - - profile_id integer not null /* comment 'account having the role'*/ references profile (id), - role varchar(32) not null /* comment 'string representing the role'*/, - created timestamp /* not null comment 'date the role was granted'*/, - - primary key (profile_id, role) - -); - -create table location_namespace ( - - id integer /*comment 'identity for this namespace'*/, - description text /* comment 'description of the namespace'*/ , - created integer not null /*comment 'date the record was created*/ , - /* modified timestamp comment 'date this record was modified',*/ - primary key (id) - -); - -create table login_token ( - user_id integer not null /* comment 'user owning this token'*/ references "user" (id), - token char(32) not null /* comment 'token useable for logging in'*/, - created timestamp not null DEFAULT CURRENT_TIMESTAMP /* comment 'date this record was created'*/, - modified timestamp /* comment 'date this record was modified'*/, - - primary key (user_id) -); - -DROP index fave_user_id_idx; -CREATE index fave_user_id_idx on fave (user_id,modified); - -DROP index subscription_subscriber_idx; -CREATE index subscription_subscriber_idx ON subscription (subscriber,created); - -DROP index subscription_subscribed_idx; -CREATE index subscription_subscribed_idx ON subscription (subscribed,created); - -DROP index notice_profile_id_idx; -CREATE index notice_profile_id_idx ON notice (profile_id,created,id); - -ALTER TABLE notice ADD COLUMN lat decimal(10, 7) /* comment 'latitude'*/; -ALTER TABLE notice ADD COLUMN lon decimal(10,7) /* comment 'longitude'*/; -ALTER TABLE notice ADD COLUMN location_id integer /* comment 'location id if possible'*/ ; -ALTER TABLE notice ADD COLUMN location_ns integer /* comment 'namespace for location'*/; -ALTER TABLE notice ADD COLUMN repeat_of integer /* comment 'notice this is a repeat of' */ references notice (id); - -ALTER TABLE profile ADD COLUMN lat decimal(10,7) /*comment 'latitude'*/ ; -ALTER TABLE profile ADD COLUMN lon decimal(10,7) /*comment 'longitude'*/; -ALTER TABLE profile ADD COLUMN location_id integer /* comment 'location id if possible'*/; -ALTER TABLE profile ADD COLUMN location_ns integer /* comment 'namespace for location'*/; - -ALTER TABLE consumer add COLUMN consumer_secret varchar(255) not null ; /*comment 'secret value'*/ - -ALTER TABLE token ADD COLUMN verifier varchar(255); /* comment 'verifier string for OAuth 1.0a',*/ -ALTER TABLE token ADD COLUMN verified_callback varchar(255); /* comment 'verified callback URL for OAuth 1.0a',*/ - -create table queue_item_new ( - id serial /* comment 'unique identifier'*/, - frame bytea not null /* comment 'data: object reference or opaque string'*/, - transport varchar(8) not null /*comment 'queue for what? "email", "jabber", "sms", "irc", ...'*/, - created timestamp not null default CURRENT_TIMESTAMP /*comment 'date this record was created'*/, - claimed timestamp /*comment 'date this item was claimed'*/, - PRIMARY KEY (id) -); - -insert into queue_item_new (frame,transport,created,claimed) - select ('0x' || notice_id::text)::bytea,transport,created,claimed from queue_item; -alter table queue_item rename to queue_item_old; -alter table queue_item_new rename to queue_item; - -ALTER TABLE confirm_address ALTER column sent set default CURRENT_TIMESTAMP; - -create table user_location_prefs ( - user_id integer not null /*comment 'user who has the preference'*/ references "user" (id), - share_location int default 1 /* comment 'Whether to share location data'*/, - created timestamp not null /*comment 'date this record was created'*/, - modified timestamp /* comment 'date this record was modified'*/, - - primary key (user_id) -); - -create table inbox ( - - user_id integer not null /* comment 'user receiving the notice' */ references "user" (id), - notice_ids bytea /* comment 'packed list of notice ids' */, - - primary key (user_id) - -); - -create table user_location_prefs ( - user_id integer not null /*comment 'user who has the preference'*/ references "user" (id), - share_location int default 1 /* comment 'Whether to share location data'*/, - created timestamp not null /*comment 'date this record was created'*/, - modified timestamp /* comment 'date this record was modified'*/, - - primary key (user_id) -); - -create table inbox ( - - user_id integer not null /* comment 'user receiving the notice' */ references "user" (id), - notice_ids bytea /* comment 'packed list of notice ids' */, - - primary key (user_id) - -); - diff --git a/db/095topeopletags.sql b/db/095topeopletags.sql deleted file mode 100644 index e193b98156..0000000000 --- a/db/095topeopletags.sql +++ /dev/null @@ -1,4 +0,0 @@ -/* populate people tags metadata */ - -insert into profile_list (tagger, tag, modified, description, private) - select distinct tagger, tag, modified, null, false from profile_tag; diff --git a/db/096to097.sql b/db/096to097.sql deleted file mode 100644 index 209a3a8811..0000000000 --- a/db/096to097.sql +++ /dev/null @@ -1,26 +0,0 @@ --- Add indexes for sorting changes in 0.9.7 - --- Allows sorting public timeline, api/statuses/repeats, and conversations by timestamp efficiently -alter table notice - add index notice_created_id_is_local_idx (created,id,is_local), - - add index notice_repeat_of_created_id_idx (repeat_of, created, id), - drop index notice_repeatof_idx, - - add index notice_conversation_created_id_idx (conversation, created, id), - drop index notice_conversation_idx; - --- Allows sorting tag-filtered public timeline by timestamp efficiently -alter table notice_tag add index notice_tag_tag_created_notice_id_idx (tag, created, notice_id); - --- Needed for sorting reply/mentions timelines -alter table reply add index reply_profile_id_modified_notice_id_idx (profile_id, modified, notice_id); - --- Needed for sorting group messages by timestamp -alter table group_inbox add index group_inbox_group_id_created_notice_id_idx (group_id, created, notice_id); - --- Helps make some reverse role lookups more efficient if there's a lot of assigned accounts -alter table profile_role add index profile_role_role_created_profile_id_idx (role, created, profile_id); - --- Fix for sorting a user's group memberships by order joined -alter table group_member add index group_member_profile_id_created_idx (profile_id, created); diff --git a/db/beta5tobeta6.sql b/db/beta5tobeta6.sql deleted file mode 100644 index e9dff17efe..0000000000 --- a/db/beta5tobeta6.sql +++ /dev/null @@ -1,28 +0,0 @@ -alter table oauth_application - modify column name varchar(255) not null unique key comment 'name of the application', - modify column access_type tinyint default 0 comment 'access type, bit 1 = read, bit 2 = write'; - -alter table user_group -add column uri varchar(255) unique key comment 'universal identifier', -add column mainpage varchar(255) comment 'page for group info to link to', -drop index nickname; - -create table conversation ( - id integer auto_increment primary key comment 'unique identifier', - uri varchar(225) unique comment 'URI of the conversation', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table local_group ( - group_id integer primary key comment 'group represented' references user_group (id), - nickname varchar(64) unique key comment 'group represented', - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -insert into local_group (group_id, nickname, created) -select id, nickname, created from user_group; - diff --git a/db/core.php b/db/core.php index a9632fe8d4..c484c8c785 100644 --- a/db/core.php +++ b/db/core.php @@ -29,1065 +29,65 @@ * double-check what we've been doing on postgres? */ -$schema['profile'] = array( - 'description' => 'local and remote users have profiles', - 'fields' => array( - 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), - 'nickname' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'nickname or username'), - 'fullname' => array('type' => 'varchar', 'length' => 255, 'description' => 'display name'), - 'profileurl' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL, cached so we dont regenerate'), - 'homepage' => array('type' => 'varchar', 'length' => 255, 'description' => 'identifying URL'), - 'bio' => array('type' => 'text', 'description' => 'descriptive biography'), - 'location' => array('type' => 'varchar', 'length' => 255, 'description' => 'physical location'), - 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'), - 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'), - 'location_id' => array('type' => 'int', 'description' => 'location id if possible'), - 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'), - - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('id'), - 'indexes' => array( - 'profile_nickname_idx' => array('nickname'), - ), - 'fulltext indexes' => array( - 'nickname' => array('nickname', 'fullname', 'location', 'bio', 'homepage') - ), +$classes = array('Profile', + 'Avatar', + 'Sms_carrier', + 'User', + 'Remote_profile', + 'Subscription', + 'Group_join_queue', + 'Subscription_queue', + 'Oauth_token_association', + 'Notice', + 'Notice_source', + 'Reply', + 'Fave', + 'Consumer', + 'Token', + 'Nonce', + 'Oauth_application', + 'Oauth_application_user', + 'Confirm_address', + 'Remember_me', + 'Queue_item', + 'Notice_tag', + 'Foreign_service', + 'Foreign_user', + 'Foreign_link', + 'Foreign_subscription', + 'Invitation', + 'Message', + // 'Notice_inbox', + 'Profile_tag', + 'Profile_list', + 'Profile_tag_subscription', + 'Profile_block', + 'User_group', + 'Related_group', + 'Group_inbox', + 'Group_member', + 'File', + 'File_oembed', + 'File_redirection', + 'File_thumbnail', + 'File_to_post', + 'Group_block', + 'Group_alias', + 'Session', + 'Deleted_notice', + 'Config', + 'Profile_role', + 'Location_namespace', + 'Login_token', + 'User_location_prefs', + 'Inbox', + 'User_im_prefs', + 'Conversation', + 'Local_group', + 'User_urlshortener_prefs', + 'Schema_version', ); -$schema['avatar'] = array( - 'fields' => array( - 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), - 'original' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'uploaded by user or generated?'), - 'width' => array('type' => 'int', 'not null' => true, 'description' => 'image width'), - 'height' => array('type' => 'int', 'not null' => true, 'description' => 'image height'), - 'mediatype' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'file type'), - 'filename' => array('type' => 'varchar', 'length' => 255, 'description' => 'local filename, if local'), - 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'avatar location'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('profile_id', 'width', 'height'), - 'unique keys' => array( - 'avatar_url_key' => array('url'), - ), - 'foreign keys' => array( - 'avatar_profile_id_fkey' => array('profile', array('profile_id' => 'id')), - ), - 'indexes' => array( - 'avatar_profile_id_idx' => array('profile_id'), - ), -); - -$schema['sms_carrier'] = array( - 'fields' => array( - 'id' => array('type' => 'int', 'not null' => true, 'description' => 'primary key for SMS carrier'), - 'name' => array('type' => 'varchar', 'length' => 64, 'description' => 'name of the carrier'), - 'email_pattern' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'sprintf pattern for making an email address from a phone number'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'sms_carrier_name_key' => array('name'), - ), -); - -$schema['user'] = array( - 'description' => 'local users', - 'fields' => array( - 'id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), - 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname or username, duped in profile'), - 'password' => array('type' => 'varchar', 'length' => 255, 'description' => 'salted password, can be null for OpenID users'), - 'email' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for password recovery etc.'), - 'incomingemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for post-by-email'), - 'emailnotifysub' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of subscriptions'), - 'emailnotifyfav' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of favorites'), - 'emailnotifynudge' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of nudges'), - 'emailnotifymsg' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of direct messages'), - 'emailnotifyattn' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of @-replies'), - 'emailmicroid' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'whether to publish email microid'), - 'language' => array('type' => 'varchar', 'length' => 50, 'description' => 'preferred language'), - 'timezone' => array('type' => 'varchar', 'length' => 50, 'description' => 'timezone'), - 'emailpost' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Post by email'), - 'sms' => array('type' => 'varchar', 'length' => 64, 'description' => 'sms phone number'), - 'carrier' => array('type' => 'int', 'description' => 'foreign key to sms_carrier'), - 'smsnotify' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS'), - 'smsreplies' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS on replies'), - 'smsemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'built from sms and carrier'), - 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'), - 'autosubscribe' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'automatically subscribe to users who subscribe to us'), - 'subscribe_policy' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => '0 = anybody can subscribe; 1 = require approval'), - 'urlshorteningservice' => array('type' => 'varchar', 'length' => 50, 'default' => 'internal', 'description' => 'service to use for auto-shortening URLs'), - 'inboxed' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'has an inbox been created for this user?'), - 'private_stream' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to limit all notices to followers only'), - - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'user_nickname_key' => array('nickname'), - 'user_email_key' => array('email'), - 'user_incomingemail_key' => array('incomingemail'), - 'user_sms_key' => array('sms'), - 'user_uri_key' => array('uri'), - ), - 'foreign keys' => array( - 'user_id_fkey' => array('profile', array('id' => 'id')), - 'user_carrier_fkey' => array('sms_carrier', array('carrier' => 'id')), - ), - 'indexes' => array( - 'user_smsemail_idx' => array('smsemail'), - ), -); - -$schema['remote_profile'] = array( - 'description' => 'remote people (OMB)', - 'fields' => array( - 'id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), - 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'), - 'postnoticeurl' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL we use for posting notices'), - 'updateprofileurl' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL we use for updates to this profile'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'remote_profile_uri_key' => array('uri'), - ), - 'foreign keys' => array( - 'remote_profile_id_fkey' => array('profile', array('id' => 'id')), - ), -); - -$schema['subscription'] = array( - 'fields' => array( - 'subscriber' => array('type' => 'int', 'not null' => true, 'description' => 'profile listening'), - 'subscribed' => array('type' => 'int', 'not null' => true, 'description' => 'profile being listened to'), - 'jabber' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'deliver jabber messages'), - 'sms' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'deliver sms messages'), - 'token' => array('type' => 'varchar', 'length' => 255, 'description' => 'authorization token'), - 'secret' => array('type' => 'varchar', 'length' => 255, 'description' => 'token secret'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('subscriber', 'subscribed'), - 'indexes' => array( - 'subscription_subscriber_idx' => array('subscriber', 'created'), - 'subscription_subscribed_idx' => array('subscribed', 'created'), - 'subscription_token_idx' => array('token'), - ), -); - -$schema['notice'] = array( - 'fields' => array( - 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), - 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'who made the update'), - 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'), - 'content' => array('type' => 'text', 'description' => 'update content'), - 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'), - 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of any attachment (image, video, bookmark, whatever)'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - 'reply_to' => array('type' => 'int', 'description' => 'notice replied to (usually a guess)'), - 'is_local' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'notice was generated by a user'), - 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'), - 'conversation' => array('type' => 'int', 'description' => 'id of root notice in this conversation'), - 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'), - 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'), - 'location_id' => array('type' => 'int', 'description' => 'location id if possible'), - 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'), - 'repeat_of' => array('type' => 'int', 'description' => 'notice this is a repeat of'), - 'object_type' => array('type' => 'varchar', 'length' => 255, 'description' => 'URI representing activity streams object type', 'default' => 'http://activitystrea.ms/schema/1.0/note'), - 'scope' => array('type' => 'int', - 'default' => '1', - 'description' => 'bit map for distribution scope; 0 = everywhere; 1 = this server only; 2 = addressees; 4 = followers'), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'notice_uri_key' => array('uri'), - ), - 'foreign keys' => array( - 'notice_profile_id_fkey' => array('profile', array('profile_id' => 'id')), - 'notice_reply_to_fkey' => array('notice', array('reply_to' => 'id')), - 'notice_conversation_fkey' => array('conversation', array('conversation' => 'id')), # note... used to refer to notice.id - 'notice_repeat_of_fkey' => array('notice', array('repeat_of' => 'id')), # @fixme: what about repeats of deleted notices? - ), - 'indexes' => array( - 'notice_profile_id_idx' => array('profile_id', 'created', 'id'), - 'notice_conversation_idx' => array('conversation'), - 'notice_created_idx' => array('created'), - 'notice_replyto_idx' => array('reply_to'), - 'notice_repeatof_idx' => array('repeat_of'), - ), - 'fulltext indexes' => array( - 'content' => array('content'), - ) -); - -$schema['notice_source'] = array( - 'fields' => array( - 'code' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'source code'), - 'name' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'name of the source'), - 'url' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'url to link to'), - 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'date this record was created'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('code'), -); - -$schema['reply'] = array( - 'fields' => array( - 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice that is the reply'), - 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'profile replied to'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - 'replied_id' => array('type' => 'int', 'description' => 'notice replied to (not used, see notice.reply_to)'), - ), - 'primary key' => array('notice_id', 'profile_id'), - 'foreign keys' => array( - 'reply_notice_id_fkey' => array('notice', array('notice_id' => 'id')), - 'reply_profile_id_fkey' => array('profile', array('profile_id' => 'id')), - ), - 'indexes' => array( - 'reply_notice_id_idx' => array('notice_id'), - 'reply_profile_id_idx' => array('profile_id'), - 'reply_replied_id_idx' => array('replied_id'), - ), -); - -$schema['fave'] = array( - 'fields' => array( - 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice that is the favorite'), - 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who likes this notice'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('notice_id', 'user_id'), - 'foreign keys' => array( - 'fave_notice_id_fkey' => array('notice', array('notice_id' => 'id')), - 'fave_user_id_fkey' => array('profile', array('user_id' => 'id')), // note: formerly referenced notice.id, but we can now record remote users' favorites - ), - 'indexes' => array( - 'fave_notice_id_idx' => array('notice_id'), - 'fave_user_id_idx' => array('user_id', 'modified'), - 'fave_modified_idx' => array('modified'), - ), -); - -/* tables for OAuth */ - -$schema['consumer'] = array( - 'description' => 'OAuth consumer record', - 'fields' => array( - 'consumer_key' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'unique identifier, root URL'), - 'consumer_secret' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'secret value'), - 'seed' => array('type' => 'char', 'length' => 32, 'not null' => true, 'description' => 'seed for new tokens by this consumer'), - - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('consumer_key'), -); - -$schema['token'] = array( - 'description' => 'OAuth token record', - 'fields' => array( - 'consumer_key' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'unique identifier, root URL'), - 'tok' => array('type' => 'char', 'length' => 32, 'not null' => true, 'description' => 'identifying value'), - 'secret' => array('type' => 'char', 'length' => 32, 'not null' => true, 'description' => 'secret value'), - 'type' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 0, 'description' => 'request or access'), - 'state' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'for requests, 0 = initial, 1 = authorized, 2 = used'), - 'verifier' => array('type' => 'varchar', 'length' => 255, 'description' => 'verifier string for OAuth 1.0a'), - 'verified_callback' => array('type' => 'varchar', 'length' => 255, 'description' => 'verified callback URL for OAuth 1.0a'), - - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('consumer_key', 'tok'), - 'foreign keys' => array( - 'token_consumer_key_fkey' => array('consumer', array('consumer_key'=> 'consumer_key')), - ), -); - -$schema['nonce'] = array( - 'description' => 'OAuth nonce record', - 'fields' => array( - 'consumer_key' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'unique identifier, root URL'), - 'tok' => array('type' => 'char', 'length' => 32, 'description' => 'buggy old value, ignored'), - 'nonce' => array('type' => 'char', 'length' => 32, 'not null' => true, 'description' => 'nonce'), - 'ts' => array('type' => 'datetime', 'not null' => true, 'description' => 'timestamp sent'), - - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('consumer_key', 'ts', 'nonce'), -); - -$schema['oauth_application'] = array( - 'description' => 'OAuth application registration record', - 'fields' => array( - 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), - 'owner' => array('type' => 'int', 'not null' => true, 'description' => 'owner of the application'), - 'consumer_key' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'application consumer key'), - 'name' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'name of the application'), - 'description' => array('type' => 'varchar', 'length' => 255, 'description' => 'description of the application'), - 'icon' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'application icon'), - 'source_url' => array('type' => 'varchar', 'length' => 255, 'description' => 'application homepage - used for source link'), - 'organization' => array('type' => 'varchar', 'length' => 255, 'description' => 'name of the organization running the application'), - 'homepage' => array('type' => 'varchar', 'length' => 255, 'description' => 'homepage for the organization'), - 'callback_url' => array('type' => 'varchar', 'length' => 255, 'description' => 'url to redirect to after authentication'), - 'type' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'type of app, 1 = browser, 2 = desktop'), - 'access_type' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'default access type, bit 1 = read, bit 2 = write'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'oauth_application_name_key' => array('name'), // in the long run, we should perhaps not force these unique, and use another source id - ), - 'foreign keys' => array( - 'oauth_application_owner_fkey' => array('profile', array('owner' => 'id')), // Are remote users allowed to create oauth application records? - 'oauth_application_consumer_key_fkey' => array('consumer', array('consumer_key' => 'consumer_key')), - ), -); - -$schema['oauth_application_user'] = array( - 'fields' => array( - 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'user of the application'), - 'application_id' => array('type' => 'int', 'not null' => true, 'description' => 'id of the application'), - 'access_type' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'access type, bit 1 = read, bit 2 = write'), - 'token' => array('type' => 'varchar', 'length' => 255, 'description' => 'request or access token'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('profile_id', 'application_id'), - 'foreign keys' => array( - 'oauth_application_user_profile_id_fkey' => array('profile', array('profile_id' => 'id')), - 'oauth_application_user_application_id_fkey' => array('oauth_application', array('application_id' => 'id')), - ), -); - -/* These are used by JanRain OpenID library */ - -$schema['oid_associations'] = array( - 'fields' => array( - 'server_url' => array('type' => 'blob', 'not null' => true), - 'handle' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'default' => ''), // character set latin1, - 'secret' => array('type' => 'blob'), - 'issued' => array('type' => 'int'), - 'lifetime' => array('type' => 'int'), - 'assoc_type' => array('type' => 'varchar', 'length' => 64), - ), - 'primary key' => array(array('server_url', 255), 'handle'), -); - -$schema['oid_nonces'] = array( - 'fields' => array( - 'server_url' => array('type' => 'varchar', 'length' => 2047), - 'timestamp' => array('type' => 'int'), - 'salt' => array('type' => 'char', 'length' => 40), - ), - 'unique keys' => array( - 'oid_nonces_server_url_timestamp_salt_key' => array(array('server_url', 255), 'timestamp', 'salt'), - ), -); - -$schema['confirm_address'] = array( - 'fields' => array( - 'code' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'good random code'), - 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who requested confirmation'), - 'address' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'address (email, xmpp, SMS, etc.)'), - 'address_extra' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'carrier ID, for SMS'), - 'address_type' => array('type' => 'varchar', 'length' => 8, 'not null' => true, 'description' => 'address type ("email", "xmpp", "sms")'), - 'claimed' => array('type' => 'datetime', 'description' => 'date this was claimed for queueing'), - 'sent' => array('type' => 'datetime', 'description' => 'date this was sent for queueing'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('code'), - 'foreign keys' => array( - 'confirm_address_user_id_fkey' => array('user', array('user_id' => 'id')), - ), -); - -$schema['remember_me'] = array( - 'fields' => array( - 'code' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'good random code'), - 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who is logged in'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('code'), - 'foreign keys' => array( - 'remember_me_user_id_fkey' => array('user', array('user_id' => 'id')), - ), -); - -$schema['queue_item'] = array( - 'fields' => array( - 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), - 'frame' => array('type' => 'blob', 'not null' => true, 'description' => 'data: object reference or opaque string'), - 'transport' => array('type' => 'varchar', 'length' => 8, 'not null' => true, 'description' => 'queue for what? "email", "xmpp", "sms", "irc", ...'), // @fixme 8 chars is too short; bump up. - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'claimed' => array('type' => 'datetime', 'description' => 'date this item was claimed'), - ), - 'primary key' => array('id'), - 'indexes' => array( - 'queue_item_created_idx' => array('created'), - ), -); - -$schema['notice_tag'] = array( - 'description' => 'Hash tags', - 'fields' => array( - 'tag' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'hash tag associated with this notice'), - 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice tagged'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - ), - 'primary key' => array('tag', 'notice_id'), - 'foreign keys' => array( - 'notice_tag_notice_id_fkey' => array('notice', array('notice_id' => 'id')), - ), - 'indexes' => array( - 'notice_tag_created_idx' => array('created'), - 'notice_tag_notice_id_idx' => array('notice_id'), - ), -); - -/* Synching with foreign services */ - -$schema['foreign_service'] = array( - 'fields' => array( - 'id' => array('type' => 'int', 'not null' => true, 'description' => 'numeric key for service'), - 'name' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'name of the service'), - 'description' => array('type' => 'varchar', 'length' => 255, 'description' => 'description'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'foreign_service_name_key' => array('name'), - ), -); - -$schema['foreign_user'] = array( - 'fields' => array( - 'id' => array('type' => 'int', 'size' => 'big', 'not null' => true, 'description' => 'unique numeric key on foreign service'), - 'service' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to service'), - 'uri' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'identifying URI'), - 'nickname' => array('type' => 'varchar', 'length' => 255, 'description' => 'nickname on foreign service'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('id', 'service'), - 'foreign keys' => array( - 'foreign_user_service_fkey' => array('foreign_service', array('service' => 'id')), - ), - 'unique keys' => array( - 'foreign_user_uri_key' => array('uri'), - ), -); - -$schema['foreign_link'] = array( - 'fields' => array( - 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'link to user on this system, if exists'), - 'foreign_id' => array('type' => 'int', 'size' => 'big', 'unsigned' => true, 'not null' => true, 'description' => 'link to user on foreign service, if exists'), - 'service' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to service'), - 'credentials' => array('type' => 'varchar', 'length' => 255, 'description' => 'authc credentials, typically a password'), - 'noticesync' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 1, 'description' => 'notice synchronization, bit 1 = sync outgoing, bit 2 = sync incoming, bit 3 = filter local replies'), - 'friendsync' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 2, 'description' => 'friend synchronization, bit 1 = sync outgoing, bit 2 = sync incoming'), - 'profilesync' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 1, 'description' => 'profile synchronization, bit 1 = sync outgoing, bit 2 = sync incoming'), - 'last_noticesync' => array('type' => 'datetime', 'description' => 'last time notices were imported'), - 'last_friendsync' => array('type' => 'datetime', 'description' => 'last time friends were imported'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('user_id', 'foreign_id', 'service'), - 'foreign keys' => array( - 'foreign_link_user_id_fkey' => array('user', array('user_id' => 'id')), - 'foreign_link_foreign_id_fkey' => array('foreign_user', array('foreign_id' => 'id', 'service' => 'service')), - 'foreign_link_service_fkey' => array('foreign_service', array('service' => 'id')), - ), - 'indexes' => array( - 'foreign_user_user_id_idx' => array('user_id'), - ), -); - -$schema['foreign_subscription'] = array( - 'fields' => array( - 'service' => array('type' => 'int', 'not null' => true, 'description' => 'service where relationship happens'), - 'subscriber' => array('type' => 'int', 'size' => 'big', 'not null' => true, 'description' => 'subscriber on foreign service'), - 'subscribed' => array('type' => 'int', 'size' => 'big', 'not null' => true, 'description' => 'subscribed user'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - ), - 'primary key' => array('service', 'subscriber', 'subscribed'), - 'foreign keys' => array( - 'foreign_subscription_service_fkey' => array('foreign_service', array('service' => 'id')), - 'foreign_subscription_subscriber_fkey' => array('foreign_user', array('subscriber' => 'id', 'service' => 'service')), - 'foreign_subscription_subscribed_fkey' => array('foreign_user', array('subscribed' => 'id', 'service' => 'service')), - ), - 'indexes' => array( - 'foreign_subscription_subscriber_idx' => array('service', 'subscriber'), - 'foreign_subscription_subscribed_idx' => array('service', 'subscribed'), - ), -); - -$schema['invitation'] = array( - 'fields' => array( - 'code' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'random code for an invitation'), - 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'who sent the invitation'), - 'address' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'invitation sent to'), - 'address_type' => array('type' => 'varchar', 'length' => 8, 'not null' => true, 'description' => 'address type ("email", "xmpp", "sms")'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'registered_user_id' => array('type' => 'int', 'not null' => false, 'description' => 'if the invitation is converted, who the new user is'), - ), - 'primary key' => array('code'), - 'foreign keys' => array( - 'invitation_user_id_fkey' => array('user', array('user_id' => 'id')), - 'invitation_registered_user_id_fkey' => array('user', array('registered_user_id' => 'id')), - ), - 'indexes' => array( - 'invitation_address_idx' => array('address', 'address_type'), - 'invitation_user_id_idx' => array('user_id'), - 'invitation_registered_user_id_idx' => array('registered_user_id'), - ), -); - -$schema['message'] = array( - 'fields' => array( - 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), - 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier'), - 'from_profile' => array('type' => 'int', 'not null' => true, 'description' => 'who the message is from'), - 'to_profile' => array('type' => 'int', 'not null' => true, 'description' => 'who the message is to'), - 'content' => array('type' => 'text', 'description' => 'message content'), - 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'), - 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of any attachment (image, video, bookmark, whatever)'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'message_uri_key' => array('uri'), - ), - 'foreign keys' => array( - 'message_from_profile_fkey' => array('profile', array('from_profile' => 'id')), - 'message_to_profile_fkey' => array('profile', array('to_profile' => 'id')), - ), - 'indexes' => array( - // @fixme these are really terrible indexes, since you can only sort on one of them at a time. - // looks like we really need a (to_profile, created) for inbox and a (from_profile, created) for outbox - 'message_from_idx' => array('from_profile'), - 'message_to_idx' => array('to_profile'), - 'message_created_idx' => array('created'), - ), -); - -$schema['notice_inbox'] = array( - 'description' => 'Obsolete; old entries here are converted to packed entries in the inbox table since 0.9', - 'fields' => array( - 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user receiving the message'), - 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice received'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice was created'), - 'source' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'reason it is in the inbox, 1=subscription'), - ), - 'primary key' => array('user_id', 'notice_id'), - 'foreign keys' => array( - 'notice_inbox_user_id_fkey' => array('user', array('user_id' => 'id')), - 'notice_inbox_notice_id_fkey' => array('notice', array('notice_id' => 'id')), - ), - 'indexes' => array( - 'notice_inbox_notice_id_idx' => array('notice_id'), - ), -); - -$schema['profile_tag'] = array( - 'fields' => array( - 'tagger' => array('type' => 'int', 'not null' => true, 'description' => 'user making the tag'), - 'tagged' => array('type' => 'int', 'not null' => true, 'description' => 'profile tagged'), - 'tag' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'hash tag associated with this notice'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date the tag was added'), - ), - 'primary key' => array('tagger', 'tagged', 'tag'), - 'foreign keys' => array( - 'profile_tag_tagger_fkey' => array('profile', array('tagger' => 'id')), - 'profile_tag_tagged_fkey' => array('profile', array('tagged' => 'id')), - 'profile_tag_tag_fkey' => array('profile_list', array('tag' => 'tag')), - ), - 'indexes' => array( - 'profile_tag_modified_idx' => array('modified'), - 'profile_tag_tagger_tag_idx' => array('tagger', 'tag'), - 'profile_tag_tagged_idx' => array('tagged'), - ), -); - -$schema['profile_list'] = array( - 'fields' => array( - 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), - 'tagger' => array('type' => 'int', 'not null' => true, 'description' => 'user making the tag'), - 'tag' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'people tag'), - 'description' => array('type' => 'text', 'description' => 'description of the people tag'), - 'private' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'is this tag private'), - - 'created' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date the tag was added'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date the tag was modified'), - - 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universal identifier'), - 'mainpage' => array('type' => 'varchar', 'length' => 255, 'description' => 'page to link to'), - 'tagged_count' => array('type' => 'int', 'default' => 0, 'description' => 'number of people tagged with this tag by this user'), - 'subscriber_count' => array('type' => 'int', 'default' => 0, 'description' => 'number of subscribers to this tag'), - ), - 'primary key' => array('tagger', 'tag'), - 'unique keys' => array( - 'profile_list_id_key' => array('id') - ), - 'foreign keys' => array( - 'profile_list_tagger_fkey' => array('profile', array('tagger' => 'id')), - ), - 'indexes' => array( - 'profile_list_modified_idx' => array('modified'), - 'profile_list_tag_idx' => array('tag'), - 'profile_list_tagger_tag_idx' => array('tagger', 'tag'), - 'profile_list_tagged_count_idx' => array('tagged_count'), - 'profile_list_subscriber_count_idx' => array('subscriber_count'), - ), -); - -$schema['profile_tag_inbox'] = array( - 'description' => 'Many-many table listing notices associated with people tags.', - 'fields' => array( - 'profile_tag_id' => array('type' => 'int', 'not null' => true, 'description' => 'people tag receiving the message'), - 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice received'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice was created'), - ), - 'primary key' => array('profile_tag_id', 'notice_id'), - 'foreign keys' => array( - 'profile_tag_inbox_profile_list_id_fkey' => array('profile_list', array('profile_tag_id' => 'id')), - 'profile_tag_inbox_notice_id_fkey' => array('notice', array('notice_id' => 'id')), - ), - 'indexes' => array( - 'profile_tag_inbox_created_idx' => array('created'), - 'profile_tag_inbox_profile_tag_id_idx' => array('profile_tag_id'), - ), -); - -$schema['profile_tag_subscription'] = array( - 'fields' => array( - 'profile_tag_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile_tag'), - 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), - - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('profile_tag_id', 'profile_id'), - 'foreign keys' => array( - 'profile_tag_subscription_profile_list_id_fkey' => array('profile_list', array('profile_tag_id' => 'id')), - 'profile_tag_subscription_profile_id_fkey' => array('profile', array('profile_id' => 'id')), - ), - 'indexes' => array( - // @fixme probably we want a (profile_id, created) index here? - 'profile_tag_subscription_profile_id_idx' => array('profile_id'), - 'profile_tag_subscription_created_idx' => array('created'), - ), -); - -$schema['profile_block'] = array( - 'fields' => array( - 'blocker' => array('type' => 'int', 'not null' => true, 'description' => 'user making the block'), - 'blocked' => array('type' => 'int', 'not null' => true, 'description' => 'profile that is blocked'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date of blocking'), - ), - 'foreign keys' => array( - 'profile_block_blocker_fkey' => array('user', array('blocker' => 'id')), - 'profile_block_blocked_fkey' => array('profile', array('blocked' => 'id')), - ), - 'primary key' => array('blocker', 'blocked'), -); - -$schema['user_group'] = array( - 'fields' => array( - 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), - - 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname for addressing'), - 'fullname' => array('type' => 'varchar', 'length' => 255, 'description' => 'display name'), - 'homepage' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL, cached so we dont regenerate'), - 'description' => array('type' => 'text', 'description' => 'group description'), - 'location' => array('type' => 'varchar', 'length' => 255, 'description' => 'related physical location, if any'), - - 'original_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'original size logo'), - 'homepage_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'homepage (profile) size logo'), - 'stream_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'stream-sized logo'), - 'mini_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'mini logo'), - - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - - 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universal identifier'), - 'mainpage' => array('type' => 'varchar', 'length' => 255, 'description' => 'page for group info to link to'), - 'join_policy' => array('type' => 'int', 'size' => 'tiny', 'description' => '0=open; 1=requires admin approval'), - 'force_scope' => array('type' => 'int', 'size' => 'tiny', 'description' => '0=never,1=sometimes,-1=always'), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'user_group_uri_key' => array('uri'), - ), - 'indexes' => array( - 'user_group_nickname_idx' => array('nickname'), - ), -); - -$schema['group_member'] = array( - 'fields' => array( - 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to user_group'), - 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), - 'is_admin' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'is this user an admin?'), - - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('group_id', 'profile_id'), - 'foreign keys' => array( - 'group_member_group_id_fkey' => array('user_group', array('group_id' => 'id')), - 'group_member_profile_id_fkey' => array('profile', array('profile_id' => 'id')), - ), - 'indexes' => array( - // @fixme probably we want a (profile_id, created) index here? - 'group_member_profile_id_idx' => array('profile_id'), - 'group_member_created_idx' => array('created'), - ), -); - -$schema['related_group'] = array( - // @fixme description for related_group? - 'fields' => array( - 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to user_group'), - 'related_group_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to user_group'), - - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - ), - 'primary key' => array('group_id', 'related_group_id'), - 'foreign keys' => array( - 'related_group_group_id_fkey' => array('user_group', array('group_id' => 'id')), - 'related_group_related_group_id_fkey' => array('user_group', array('related_group_id' => 'id')), - ), -); - -$schema['group_inbox'] = array( - 'description' => 'Many-many table listing notices posted to a given group, or which groups a given notice was posted to.', - 'fields' => array( - 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'group receiving the message'), - 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice received'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice was created'), - ), - 'primary key' => array('group_id', 'notice_id'), - 'foreign keys' => array( - 'group_inbox_group_id_fkey' => array('user_group', array('group_id' => 'id')), - 'group_inbox_notice_id_fkey' => array('notice', array('notice_id' => 'id')), - ), - 'indexes' => array( - 'group_inbox_created_idx' => array('created'), - 'group_inbox_notice_id_idx' => array('notice_id'), - ), -); - -$schema['file'] = array( - 'fields' => array( - 'id' => array('type' => 'serial', 'not null' => true), - 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'destination URL after following redirections'), - 'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'), - 'size' => array('type' => 'int', 'description' => 'size of resource when available'), - 'title' => array('type' => 'varchar', 'length' => 255, 'description' => 'title of resource when available'), - 'date' => array('type' => 'int', 'description' => 'date of resource according to http query'), - 'protected' => array('type' => 'int', 'description' => 'true when URL is private (needs login)'), - 'filename' => array('type' => 'varchar', 'length' => 255, 'description' => 'if a local file, name of the file'), - - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'file_url_key' => array('url'), - ), -); - -$schema['file_oembed'] = array( - 'fields' => array( - 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'oEmbed for that URL/file'), - 'version' => array('type' => 'varchar', 'length' => 20, 'description' => 'oEmbed spec. version'), - 'type' => array('type' => 'varchar', 'length' => 20, 'description' => 'oEmbed type: photo, video, link, rich'), - 'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'), - 'provider' => array('type' => 'varchar', 'length' => 50, 'description' => 'name of this oEmbed provider'), - 'provider_url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of this oEmbed provider'), - 'width' => array('type' => 'int', 'description' => 'width of oEmbed resource when available'), - 'height' => array('type' => 'int', 'description' => 'height of oEmbed resource when available'), - 'html' => array('type' => 'text', 'description' => 'html representation of this oEmbed resource when applicable'), - 'title' => array('type' => 'varchar', 'length' => 255, 'description' => 'title of oEmbed resource when available'), - 'author_name' => array('type' => 'varchar', 'length' => 50, 'description' => 'author name for this oEmbed resource'), - 'author_url' => array('type' => 'varchar', 'length' => 255, 'description' => 'author URL for this oEmbed resource'), - 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL for this oEmbed resource when applicable (photo, link)'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('file_id'), - 'foreign keys' => array( - 'file_oembed_file_id_fkey' => array('file', array('file_id' => 'id')), - ), -); - -$schema['file_redirection'] = array( - 'fields' => array( - 'url' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'short URL (or any other kind of redirect) for file (id)'), - 'file_id' => array('type' => 'int', 'description' => 'short URL for what URL/file'), - 'redirections' => array('type' => 'int', 'description' => 'redirect count'), - 'httpcode' => array('type' => 'int', 'description' => 'HTTP status code (20x, 30x, etc.)'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('url'), - 'foreign keys' => array( - 'file_redirection_file_id_fkey' => array('file' => array('file_id' => 'id')), - ), -); - -$schema['file_thumbnail'] = array( - 'fields' => array( - 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'thumbnail for what URL/file'), - 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of thumbnail'), - 'width' => array('type' => 'int', 'description' => 'width of thumbnail'), - 'height' => array('type' => 'int', 'description' => 'height of thumbnail'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('file_id'), - 'foreign keys' => array( - 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')), - ), - 'unique keys' => array( - 'file_thumbnail_url_key' => array('url'), - ), -); - -$schema['file_to_post'] = array( - 'fields' => array( - 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'id of URL/file'), - 'post_id' => array('type' => 'int', 'not null' => true, 'description' => 'id of the notice it belongs to'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('file_id', 'post_id'), - 'foreign keys' => array( - 'file_to_post_file_id_fkey' => array('file', array('file_id' => 'id')), - 'file_to_post_post_id_fkey' => array('notice', array('post_id' => 'id')), - ), - 'indexes' => array( - 'post_id_idx' => array('post_id'), - ), -); - -$schema['group_block'] = array( - 'fields' => array( - 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'group profile is blocked from'), - 'blocked' => array('type' => 'int', 'not null' => true, 'description' => 'profile that is blocked'), - 'blocker' => array('type' => 'int', 'not null' => true, 'description' => 'user making the block'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date of blocking'), - ), - 'primary key' => array('group_id', 'blocked'), - 'foreign keys' => array( - 'group_block_group_id_fkey' => array('user_group', array('group_id' => 'id')), - 'group_block_blocked_fkey' => array('profile', array('blocked' => 'id')), - 'group_block_blocker_fkey' => array('user', array('blocker' => 'id')), - ), -); - -$schema['group_alias'] = array( - 'fields' => array( - 'alias' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'additional nickname for the group'), - 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'group profile is blocked from'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date alias was created'), - ), - 'primary key' => array('alias'), - 'foreign keys' => array( - 'group_alias_group_id_fkey' => array('user_group', array('group_id' => 'id')), - ), - 'indexes' => array( - 'group_alias_group_id_idx' => array('group_id'), - ), -); - -$schema['session'] = array( - 'fields' => array( - 'id' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'session ID'), - 'session_data' => array('type' => 'text', 'description' => 'session data'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('id'), - 'indexes' => array( - 'session_modified_idx' => array('modified'), - ), -); - -$schema['deleted_notice'] = array( - 'fields' => array( - 'id' => array('type' => 'int', 'not null' => true, 'description' => 'identity of notice'), - 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'author of the notice'), - 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice record was created'), - 'deleted' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice record was created'), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'deleted_notice_uri_key' => array('uri'), - ), - 'indexes' => array( - 'deleted_notice_profile_id_idx' => array('profile_id'), - ), -); - -$schema['config'] = array( - 'fields' => array( - 'section' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'default' => '', 'description' => 'configuration section'), - 'setting' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'default' => '', 'description' => 'configuration setting'), - 'value' => array('type' => 'varchar', 'length' => 255, 'description' => 'configuration value'), - ), - 'primary key' => array('section', 'setting'), -); - -$schema['profile_role'] = array( - 'fields' => array( - 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'account having the role'), - 'role' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'string representing the role'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the role was granted'), - ), - 'primary key' => array('profile_id', 'role'), - 'foreign keys' => array( - 'profile_role_profile_id_fkey' => array('profile', array('profile_id' => 'id')), - ), -); - -$schema['location_namespace'] = array( - 'fields' => array( - 'id' => array('type' => 'int', 'not null' => true, 'description' => 'identity for this namespace'), - 'description' => array('type' => 'varchar', 'length' => 255, 'description' => 'description of the namespace'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('id'), -); - -$schema['login_token'] = array( - 'fields' => array( - 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user owning this token'), - 'token' => array('type' => 'char', 'length' => 32, 'not null' => true, 'description' => 'token useable for logging in'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('user_id'), - 'foreign keys' => array( - 'login_token_user_id_fkey' => array('user', array('user_id' => 'id')), - ), -); - -$schema['user_location_prefs'] = array( - 'fields' => array( - 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user who has the preference'), - 'share_location' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Whether to share location data'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('user_id'), - 'foreign keys' => array( - 'user_location_prefs_user_id_fkey' => array('user', array('user_id' => 'id')), - ), -); - -$schema['inbox'] = array( - 'fields' => array( - 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user receiving the notice'), - 'notice_ids' => array('type' => 'blob', 'description' => 'packed list of notice ids'), - ), - 'primary key' => array('user_id'), - 'foreign keys' => array( - 'inbox_user_id_fkey' => array('user', array('user_id' => 'id')), - ), -); - -// @fixme possibly swap this for a more general prefs table? -$schema['user_im_prefs'] = array( - 'fields' => array( - 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user'), - 'screenname' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'screenname on this service'), - 'transport' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'transport (ex xmpp, aim)'), - 'notify' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 0, 'description' => 'Notify when a new notice is sent'), - 'replies' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 0, 'description' => 'Send replies from people not subscribed to'), - 'microid' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 1, 'description' => 'Publish a MicroID'), - 'updatefrompresence' => array('type' => 'int', 'size' => 'tiny', 'not null' => true, 'default' => 0, 'description' => 'Send replies from people not subscribed to.'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('user_id', 'transport'), - 'unique keys' => array( - 'transport_screenname_key' => array('transport', 'screenname'), - ), - 'foreign keys' => array( - 'user_im_prefs_user_id_fkey' => array('user', array('user_id' => 'id')), - ), -); - -$schema['conversation'] = array( - 'fields' => array( - 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), - 'uri' => array('type' => 'varchar', 'length' => 225, 'description' => 'URI of the conversation'), - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('id'), - 'unique keys' => array( - 'conversation_uri_key' => array('uri'), - ), -); - -$schema['local_group'] = array( - 'description' => 'Record for a user group on the local site, with some additional info not in user_group', - 'fields' => array( - 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'group represented'), - 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'group represented'), - - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('group_id'), - 'foreign keys' => array( - 'local_group_group_id_fkey' => array('user_group', array('group_id' => 'id')), - ), - 'unique keys' => array( - 'local_group_nickname_key' => array('nickname'), - ), -); - -$schema['user_urlshortener_prefs'] = array( - 'fields' => array( - 'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user'), - 'urlshorteningservice' => array('type' => 'varchar', 'length' => 50, 'default' => 'internal', 'description' => 'service to use for auto-shortening URLs'), - 'maxurllength' => array('type' => 'int', 'not null' => true, 'description' => 'urls greater than this length will be shortened, 0 = always, null = never'), - 'maxnoticelength' => array('type' => 'int', 'not null' => true, 'description' => 'notices with content greater than this value will have all urls shortened, 0 = always, null = never'), - - 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('user_id'), - 'foreign keys' => array( - 'user_urlshortener_prefs_user_id_fkey' => array('user', array('user_id' => 'id')), - ), -); - -$schema['schema_version'] = array( - 'description' => 'To avoid checking database structure all the time, we store a checksum of the expected schema info for each table here. If it has not changed since the last time we checked the table, we can leave it as is.', - 'fields' => array( - 'table_name' => array('type' => 'varchar', 'length' => '64', 'not null' => true, 'description' => 'Table name'), - 'checksum' => array('type' => 'varchar', 'length' => '64', 'not null' => true, 'description' => 'Checksum of schema array; a mismatch indicates we should check the table more thoroughly.'), - 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), - ), - 'primary key' => array('table_name'), -); - -$schema['group_join_queue'] = Group_join_queue::schemaDef(); - -$schema['subscription_queue'] = Subscription_queue::schemaDef(); - -$schema['oauth_token_association'] = Oauth_token_association::schemaDef(); +foreach ($classes as $cls) { + $schema[strtolower($cls)] = call_user_func(array($cls, 'schemaDef')); +} diff --git a/db/innodb.sql b/db/innodb.sql deleted file mode 100644 index f3ab6cd690..0000000000 --- a/db/innodb.sql +++ /dev/null @@ -1,2 +0,0 @@ -alter table profile drop index nickname, engine=InnoDB; -alter table notice drop index content, engine=InnoDB; diff --git a/db/rc2torc3.sql b/db/rc2torc3.sql deleted file mode 100644 index 886b9adf22..0000000000 --- a/db/rc2torc3.sql +++ /dev/null @@ -1,17 +0,0 @@ -create table user_location_prefs ( - user_id integer not null comment 'user who has the preference' references user (id), - share_location tinyint default 1 comment 'Whether to share location data', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (user_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table inbox ( - - user_id integer not null comment 'user receiving the notice' references user (id), - notice_ids blob comment 'packed list of notice ids', - - constraint primary key (user_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; diff --git a/db/rc3torc4.sql b/db/rc3torc4.sql deleted file mode 100644 index 917c1f1c41..0000000000 --- a/db/rc3torc4.sql +++ /dev/null @@ -1,50 +0,0 @@ -create table queue_item_new ( - id integer auto_increment primary key comment 'unique identifier', - frame blob not null comment 'data: object reference or opaque string', - transport varchar(8) not null comment 'queue for what? "email", "jabber", "sms", "irc", ...', - created datetime not null comment 'date this record was created', - claimed datetime comment 'date this item was claimed', - - index queue_item_created_idx (created) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -insert into queue_item_new (frame,transport,created,claimed) - select notice_id,transport,created,claimed from queue_item; -alter table queue_item rename to queue_item_old; -alter table queue_item_new rename to queue_item; - -alter table consumer - add consumer_secret varchar(255) not null comment 'secret value'; - -alter table token - add verifier varchar(255) comment 'verifier string for OAuth 1.0a', - add verified_callback varchar(255) comment 'verified callback URL for OAuth 1.0a'; - -create table oauth_application ( - id integer auto_increment primary key comment 'unique identifier', - owner integer not null comment 'owner of the application' references profile (id), - consumer_key varchar(255) not null comment 'application consumer key' references consumer (consumer_key), - name varchar(255) not null comment 'name of the application', - description varchar(255) comment 'description of the application', - icon varchar(255) not null comment 'application icon', - source_url varchar(255) comment 'application homepage - used for source link', - organization varchar(255) comment 'name of the organization running the application', - homepage varchar(255) comment 'homepage for the organization', - callback_url varchar(255) comment 'url to redirect to after authentication', - type tinyint default 0 comment 'type of app, 1 = browser, 2 = desktop', - access_type tinyint default 0 comment 'default access type, bit 1 = read, bit 2 = write', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table oauth_application_user ( - profile_id integer not null comment 'user of the application' references profile (id), - application_id integer not null comment 'id of the application' references oauth_application (id), - access_type tinyint default 0 comment 'access type, bit 1 = read, bit 2 = write, bit 3 = revoked', - token varchar(255) comment 'request or access token', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - constraint primary key (profile_id, application_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - diff --git a/db/site_093to094.sql b/db/site_093to094.sql deleted file mode 100644 index 30cea31dfa..0000000000 --- a/db/site_093to094.sql +++ /dev/null @@ -1,13 +0,0 @@ -alter table status_network - drop primary key, - add column site_id integer auto_increment primary key first, - add unique key (nickname); - -create table status_network_tag ( - site_id integer comment 'unique id', - tag varchar(64) comment 'tag name', - created datetime not null comment 'date the record was created', - - constraint primary key (site_id, tag) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_general_ci; - diff --git a/db/statusnet.sql b/db/statusnet.sql deleted file mode 100644 index 29a555948b..0000000000 --- a/db/statusnet.sql +++ /dev/null @@ -1,759 +0,0 @@ -/* local and remote users have profiles */ - -create table profile ( - - id integer auto_increment primary key comment 'unique identifier', - nickname varchar(64) not null comment 'nickname or username', - fullname varchar(255) comment 'display name', - profileurl varchar(255) comment 'URL, cached so we dont regenerate', - homepage varchar(255) comment 'identifying URL', - bio text comment 'descriptive biography', - location varchar(255) comment 'physical location', - lat decimal(10,7) comment 'latitude', - lon decimal(10,7) comment 'longitude', - location_id integer comment 'location id if possible', - location_ns integer comment 'namespace for location', - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - index profile_nickname_idx (nickname), - FULLTEXT(nickname, fullname, location, bio, homepage) -) ENGINE=MyISAM CHARACTER SET utf8 COLLATE utf8_general_ci; - -create table avatar ( - profile_id integer not null comment 'foreign key to profile table' references profile (id), - original boolean default false comment 'uploaded by user or generated?', - width integer not null comment 'image width', - height integer not null comment 'image height', - mediatype varchar(32) not null comment 'file type', - filename varchar(255) null comment 'local filename, if local', - url varchar(255) unique key comment 'avatar location', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (profile_id, width, height), - index avatar_profile_id_idx (profile_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table sms_carrier ( - id integer primary key comment 'primary key for SMS carrier', - name varchar(64) unique key comment 'name of the carrier', - email_pattern varchar(255) not null comment 'sprintf pattern for making an email address from a phone number', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -/* local users */ - -create table user ( - - id integer primary key comment 'foreign key to profile table' references profile (id), - nickname varchar(64) unique key comment 'nickname or username, duped in profile', - password varchar(255) comment 'salted password, can be null for OpenID users', - email varchar(255) unique key comment 'email address for password recovery etc.', - incomingemail varchar(255) unique key comment 'email address for post-by-email', - emailnotifysub tinyint default 1 comment 'Notify by email of subscriptions', - emailnotifyfav tinyint default 1 comment 'Notify by email of favorites', - emailnotifynudge tinyint default 1 comment 'Notify by email of nudges', - emailnotifymsg tinyint default 1 comment 'Notify by email of direct messages', - emailnotifyattn tinyint default 1 comment 'Notify by email of @-replies', - emailmicroid tinyint default 1 comment 'whether to publish email microid', - language varchar(50) comment 'preferred language', - timezone varchar(50) comment 'timezone', - emailpost tinyint default 1 comment 'Post by email', - sms varchar(64) unique key comment 'sms phone number', - carrier integer comment 'foreign key to sms_carrier' references sms_carrier (id), - smsnotify tinyint default 0 comment 'whether to send notices to SMS', - smsreplies tinyint default 0 comment 'whether to send notices to SMS on replies', - smsemail varchar(255) comment 'built from sms and carrier', - uri varchar(255) unique key comment 'universally unique identifier, usually a tag URI', - autosubscribe tinyint default 0 comment 'automatically subscribe to users who subscribe to us', - urlshorteningservice varchar(50) default 'ur1.ca' comment 'service to use for auto-shortening URLs', - inboxed tinyint default 0 comment 'has an inbox been created for this user?', - design_id integer comment 'id of a design' references design(id), - viewdesigns tinyint default 1 comment 'whether to view user-provided designs', - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - index user_smsemail_idx (smsemail) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_general_ci; - -/* remote people */ - -create table remote_profile ( - id integer primary key comment 'foreign key to profile table' references profile (id), - uri varchar(255) unique key comment 'universally unique identifier, usually a tag URI', - postnoticeurl varchar(255) comment 'URL we use for posting notices', - updateprofileurl varchar(255) comment 'URL we use for updates to this profile', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table subscription ( - subscriber integer not null comment 'profile listening', - subscribed integer not null comment 'profile being listened to', - jabber tinyint default 1 comment 'deliver jabber messages', - sms tinyint default 1 comment 'deliver sms messages', - token varchar(255) comment 'authorization token', - secret varchar(255) comment 'token secret', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (subscriber, subscribed), - index subscription_subscriber_idx (subscriber, created), - index subscription_subscribed_idx (subscribed, created), - index subscription_token_idx (token) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table notice ( - id integer auto_increment primary key comment 'unique identifier', - profile_id integer not null comment 'who made the update' references profile (id), - uri varchar(255) unique key comment 'universally unique identifier, usually a tag URI', - content text comment 'update content', - rendered text comment 'HTML version of the content', - url varchar(255) comment 'URL of any attachment (image, video, bookmark, whatever)', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - reply_to integer comment 'notice replied to (usually a guess)' references notice (id), - is_local tinyint default 0 comment 'notice was generated by a user', - source varchar(32) comment 'source of comment, like "web", "im", or "clientname"', - conversation integer comment 'id of root notice in this conversation' references notice (id), - lat decimal(10,7) comment 'latitude', - lon decimal(10,7) comment 'longitude', - location_id integer comment 'location id if possible', - location_ns integer comment 'namespace for location', - repeat_of integer comment 'notice this is a repeat of' references notice (id), - - -- For public timeline... - index notice_created_id_is_local_idx (created,id,is_local), - - -- For profile timelines... - index notice_profile_id_idx (profile_id,created,id), - - -- For api/statuses/repeats... - index notice_repeat_of_created_id_idx (repeat_of, created, id), - - -- For conversation views - index notice_conversation_created_id_idx (conversation, created, id), - - -- Are these needed/used? - index notice_replyto_idx (reply_to), - - FULLTEXT(content) -) ENGINE=MyISAM CHARACTER SET utf8 COLLATE utf8_general_ci; - -create table notice_source ( - code varchar(32) primary key not null comment 'source code', - name varchar(255) not null comment 'name of the source', - url varchar(255) not null comment 'url to link to', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table reply ( - notice_id integer not null comment 'notice that is the reply' references notice (id), - profile_id integer not null comment 'profile replied to' references profile (id), - modified timestamp not null comment 'date this record was modified', - replied_id integer comment 'notice replied to (not used, see notice.reply_to)', - - constraint primary key (notice_id, profile_id), - index reply_notice_id_idx (notice_id), - index reply_profile_id_idx (profile_id), - index reply_replied_id_idx (replied_id), - - -- Needed for sorting reply/mentions timelines - index reply_profile_id_modified_notice_id_idx (profile_id, modified, notice_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table fave ( - notice_id integer not null comment 'notice that is the favorite' references notice (id), - user_id integer not null comment 'user who likes this notice' references user (id), - modified timestamp not null comment 'date this record was modified', - - constraint primary key (notice_id, user_id), - index fave_notice_id_idx (notice_id), - index fave_user_id_idx (user_id,modified), - index fave_modified_idx (modified) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -/* tables for OAuth */ - -create table consumer ( - consumer_key varchar(255) primary key comment 'unique identifier, root URL', - consumer_secret varchar(255) not null comment 'secret value', - seed char(32) not null comment 'seed for new tokens by this consumer', - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table token ( - consumer_key varchar(255) not null comment 'unique identifier, root URL' references consumer (consumer_key), - tok char(32) not null comment 'identifying value', - secret char(32) not null comment 'secret value', - type tinyint not null default 0 comment 'request or access', - state tinyint default 0 comment 'for requests, 0 = initial, 1 = authorized, 2 = used', - verifier varchar(255) comment 'verifier string for OAuth 1.0a', - verified_callback varchar(255) comment 'verified callback URL for OAuth 1.0a', - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (consumer_key, tok) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table nonce ( - consumer_key varchar(255) not null comment 'unique identifier, root URL', - tok char(32) null comment 'buggy old value, ignored', - nonce char(32) not null comment 'nonce', - ts datetime not null comment 'timestamp sent', - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (consumer_key, ts, nonce) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table oauth_application ( - id integer auto_increment primary key comment 'unique identifier', - owner integer not null comment 'owner of the application' references profile (id), - consumer_key varchar(255) not null comment 'application consumer key' references consumer (consumer_key), - name varchar(255) not null unique key comment 'name of the application', - description varchar(255) comment 'description of the application', - icon varchar(255) not null comment 'application icon', - source_url varchar(255) comment 'application homepage - used for source link', - organization varchar(255) comment 'name of the organization running the application', - homepage varchar(255) comment 'homepage for the organization', - callback_url varchar(255) comment 'url to redirect to after authentication', - type tinyint default 0 comment 'type of app, 1 = browser, 2 = desktop', - access_type tinyint default 0 comment 'default access type, bit 1 = read, bit 2 = write', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table oauth_application_user ( - profile_id integer not null comment 'user of the application' references profile (id), - application_id integer not null comment 'id of the application' references oauth_application (id), - access_type tinyint default 0 comment 'access type, bit 1 = read, bit 2 = write', - token varchar(255) comment 'request or access token', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - constraint primary key (profile_id, application_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table oauth_token_association ( - profile_id integer not null comment 'user of the application' references profile (id), - application_id integer not null comment 'id of the application' references oauth_application (id), - token varchar(255) comment 'request or access token', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - constraint primary key (profile_id, application_id, token) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -/* These are used by JanRain OpenID library */ - -create table oid_associations ( - server_url BLOB, - handle VARCHAR(255) character set latin1, - secret BLOB, - issued INTEGER, - lifetime INTEGER, - assoc_type VARCHAR(64), - PRIMARY KEY (server_url(255), handle) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table oid_nonces ( - server_url VARCHAR(2047), - timestamp INTEGER, - salt CHAR(40), - UNIQUE (server_url(255), timestamp, salt) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table confirm_address ( - code varchar(32) not null primary key comment 'good random code', - user_id integer not null comment 'user who requested confirmation' references user (id), - address varchar(255) not null comment 'address (email, xmpp, SMS, etc.)', - address_extra varchar(255) not null comment 'carrier ID, for SMS', - address_type varchar(8) not null comment 'address type ("email", "xmpp", "sms")', - claimed datetime comment 'date this was claimed for queueing', - sent datetime comment 'date this was sent for queueing', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table remember_me ( - code varchar(32) not null primary key comment 'good random code', - user_id integer not null comment 'user who is logged in' references user (id), - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table queue_item ( - id integer auto_increment primary key comment 'unique identifier', - frame blob not null comment 'data: object reference or opaque string', - transport varchar(8) not null comment 'queue for what? "email", "xmpp", "sms", "irc", ...', - created datetime not null comment 'date this record was created', - claimed datetime comment 'date this item was claimed', - - index queue_item_created_idx (created) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -/* Hash tags */ -create table notice_tag ( - tag varchar( 64 ) not null comment 'hash tag associated with this notice', - notice_id integer not null comment 'notice tagged' references notice (id), - created datetime not null comment 'date this record was created', - - constraint primary key (tag, notice_id), - index notice_tag_created_idx (created), - index notice_tag_notice_id_idx (notice_id), - - -- For sorting tag-filtered public timeline - index notice_tag_tag_created_notice_id_idx (tag, created, notice_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -/* Synching with foreign services */ - -create table foreign_service ( - id int not null primary key comment 'numeric key for service', - name varchar(32) not null unique key comment 'name of the service', - description varchar(255) comment 'description', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table foreign_user ( - id bigint not null comment 'unique numeric key on foreign service', - service int not null comment 'foreign key to service' references foreign_service(id), - uri varchar(255) not null unique key comment 'identifying URI', - nickname varchar(255) comment 'nickname on foreign service', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (id, service) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table foreign_link ( - user_id int comment 'link to user on this system, if exists' references user (id), - foreign_id bigint unsigned comment 'link to user on foreign service, if exists' references foreign_user(id), - service int not null comment 'foreign key to service' references foreign_service(id), - credentials varchar(255) comment 'authc credentials, typically a password', - noticesync tinyint not null default 1 comment 'notice synchronization, bit 1 = sync outgoing, bit 2 = sync incoming, bit 3 = filter local replies', - friendsync tinyint not null default 2 comment 'friend synchronization, bit 1 = sync outgoing, bit 2 = sync incoming', - profilesync tinyint not null default 1 comment 'profile synchronization, bit 1 = sync outgoing, bit 2 = sync incoming', - last_noticesync datetime default null comment 'last time notices were imported', - last_friendsync datetime default null comment 'last time friends were imported', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (user_id, foreign_id, service), - index foreign_user_user_id_idx (user_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table foreign_subscription ( - service int not null comment 'service where relationship happens' references foreign_service(id), - subscriber int not null comment 'subscriber on foreign service' references foreign_user (id), - subscribed int not null comment 'subscribed user' references foreign_user (id), - created datetime not null comment 'date this record was created', - - constraint primary key (service, subscriber, subscribed), - index foreign_subscription_subscriber_idx (subscriber), - index foreign_subscription_subscribed_idx (subscribed) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table invitation ( - code varchar(32) not null primary key comment 'random code for an invitation', - user_id int not null comment 'who sent the invitation' references user (id), - address varchar(255) not null comment 'invitation sent to', - address_type varchar(8) not null comment 'address type ("email", "xmpp", "sms")', - created datetime not null comment 'date this record was created', - - index invitation_address_idx (address, address_type), - index invitation_user_id_idx (user_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table message ( - id integer auto_increment primary key comment 'unique identifier', - uri varchar(255) unique key comment 'universally unique identifier', - from_profile integer not null comment 'who the message is from' references profile (id), - to_profile integer not null comment 'who the message is to' references profile (id), - content text comment 'message content', - rendered text comment 'HTML version of the content', - url varchar(255) comment 'URL of any attachment (image, video, bookmark, whatever)', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - source varchar(32) comment 'source of comment, like "web", "im", or "clientname"', - - index message_from_idx (from_profile), - index message_to_idx (to_profile), - index message_created_idx (created) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_general_ci; - -create table notice_inbox ( - user_id integer not null comment 'user receiving the message' references user (id), - notice_id integer not null comment 'notice received' references notice (id), - created datetime not null comment 'date the notice was created', - source tinyint default 1 comment 'reason it is in the inbox, 1=subscription', - - constraint primary key (user_id, notice_id), - index notice_inbox_notice_id_idx (notice_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table profile_tag ( - tagger integer not null comment 'user making the tag' references profile (id), - tagged integer not null comment 'profile tagged' references profile (id), - tag varchar(64) not null comment 'hash tag associated with this notice', - modified timestamp comment 'date the tag was added', - - constraint primary key (tagger, tagged, tag), - index profile_tag_modified_idx (modified), - index profile_tag_tagger_tag_idx (tagger, tag), - index profile_tag_tagged_idx (tagged) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -/* people tag metadata */ -create table profile_list ( - id integer auto_increment unique key comment 'unique identifier', - tagger integer not null comment 'user making the tag' references profile (id), - tag varchar(64) not null comment 'hash tag', - description text comment 'description for the tag', - private tinyint(1) default 0 comment 'is this list private', - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - uri varchar(255) unique key comment 'universal identifier', - mainpage varchar(255) comment 'page for tag info info to link to', - tagged_count smallint not null default 0 comment 'number of people tagged', - subscriber_count smallint not null default 0 comment 'number of people subscribing', - - constraint primary key (tagger, tag), - index profile_list_tag_idx (tag), - index profile_list_tagged_count_idx (tagged_count), - index profile_list_modified_idx (modified), - index profile_list_subscriber_count_idx (subscriber_count) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table profile_tag_inbox ( - profile_tag_id integer not null comment 'peopletag receiving the message' references profile_tag (id), - notice_id integer not null comment 'notice received' references notice (id), - created datetime not null comment 'date the notice was created', - - constraint primary key (profile_tag_id, notice_id), - index profile_tag_inbox_created_idx (created), - index profile_tag_inbox_notice_id_idx (notice_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table profile_tag_subscription ( - profile_tag_id integer not null comment 'foreign key to profile_tag' references profile_list (id), - - profile_id integer not null comment 'foreign key to profile table' references profile (id), - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (profile_tag_id, profile_id), - index profile_tag_subscription_profile_id_idx (profile_id), - index profile_tag_subscription_created_idx (created) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table profile_block ( - blocker integer not null comment 'user making the block' references user (id), - blocked integer not null comment 'profile that is blocked' references profile (id), - modified timestamp comment 'date of blocking', - - constraint primary key (blocker, blocked) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table user_group ( - id integer auto_increment primary key comment 'unique identifier', - - nickname varchar(64) comment 'nickname for addressing', - fullname varchar(255) comment 'display name', - homepage varchar(255) comment 'URL, cached so we dont regenerate', - description text comment 'group description', - location varchar(255) comment 'related physical location, if any', - - original_logo varchar(255) comment 'original size logo', - homepage_logo varchar(255) comment 'homepage (profile) size logo', - stream_logo varchar(255) comment 'stream-sized logo', - mini_logo varchar(255) comment 'mini logo', - design_id integer comment 'id of a design' references design(id), - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - uri varchar(255) unique key comment 'universal identifier', - mainpage varchar(255) comment 'page for group info to link to', - - index user_group_nickname_idx (nickname) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_general_ci; - -create table group_member ( - group_id integer not null comment 'foreign key to user_group' references user_group (id), - profile_id integer not null comment 'foreign key to profile table' references profile (id), - is_admin boolean default false comment 'is this user an admin?', - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (group_id, profile_id), - index group_member_profile_id_idx (profile_id), - index group_member_created_idx (created), - - -- To pull up a list of someone's groups in order joined - index group_member_profile_id_created_idx (profile_id, created) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table related_group ( - group_id integer not null comment 'foreign key to user_group' references user_group (id), - related_group_id integer not null comment 'foreign key to user_group' references user_group (id), - - created datetime not null comment 'date this record was created', - - constraint primary key (group_id, related_group_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table group_inbox ( - group_id integer not null comment 'group receiving the message' references user_group (id), - notice_id integer not null comment 'notice received' references notice (id), - created datetime not null comment 'date the notice was created', - - constraint primary key (group_id, notice_id), - index group_inbox_created_idx (created), - index group_inbox_notice_id_idx (notice_id), - - -- Needed for sorting group messages by timestamp - index group_inbox_group_id_created_notice_id_idx (group_id, created, notice_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table file ( - - id integer primary key auto_increment, - url varchar(255) comment 'destination URL after following redirections', - mimetype varchar(50) comment 'mime type of resource', - size integer comment 'size of resource when available', - title varchar(255) comment 'title of resource when available', - date integer(11) comment 'date of resource according to http query', - protected integer(1) comment 'true when URL is private (needs login)', - filename varchar(255) comment 'if a local file, name of the file', - - modified timestamp comment 'date this record was modified', - - unique(url) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_general_ci; - -create table file_oembed ( - file_id integer primary key comment 'oEmbed for that URL/file' references file (id), - version varchar(20) comment 'oEmbed spec. version', - type varchar(20) comment 'oEmbed type: photo, video, link, rich', - mimetype varchar(50) comment 'mime type of resource', - provider varchar(50) comment 'name of this oEmbed provider', - provider_url varchar(255) comment 'URL of this oEmbed provider', - width integer comment 'width of oEmbed resource when available', - height integer comment 'height of oEmbed resource when available', - html text comment 'html representation of this oEmbed resource when applicable', - title varchar(255) comment 'title of oEmbed resource when available', - author_name varchar(50) comment 'author name for this oEmbed resource', - author_url varchar(255) comment 'author URL for this oEmbed resource', - url varchar(255) comment 'URL for this oEmbed resource when applicable (photo, link)', - modified timestamp comment 'date this record was modified' - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_general_ci; - -create table file_redirection ( - - url varchar(255) primary key comment 'short URL (or any other kind of redirect) for file (id)', - file_id integer comment 'short URL for what URL/file' references file (id), - redirections integer comment 'redirect count', - httpcode integer comment 'HTTP status code (20x, 30x, etc.)', - modified timestamp comment 'date this record was modified' - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table file_thumbnail ( - - file_id integer primary key comment 'thumbnail for what URL/file' references file (id), - url varchar(255) comment 'URL of thumbnail', - width integer comment 'width of thumbnail', - height integer comment 'height of thumbnail', - modified timestamp comment 'date this record was modified', - - unique(url) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table file_to_post ( - - file_id integer comment 'id of URL/file' references file (id), - post_id integer comment 'id of the notice it belongs to' references notice (id), - modified timestamp comment 'date this record was modified', - - constraint primary key (file_id, post_id), - index post_id_idx (post_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table design ( - id integer primary key auto_increment comment 'design ID', - backgroundcolor integer comment 'main background color', - contentcolor integer comment 'content area background color', - sidebarcolor integer comment 'sidebar background color', - textcolor integer comment 'text color', - linkcolor integer comment 'link color', - backgroundimage varchar(255) comment 'background image, if any', - disposition tinyint default 1 comment 'bit 1 = hide background image, bit 2 = display background image, bit 4 = tile background image' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table group_block ( - group_id integer not null comment 'group profile is blocked from' references user_group (id), - blocked integer not null comment 'profile that is blocked' references profile (id), - blocker integer not null comment 'user making the block' references user (id), - modified timestamp comment 'date of blocking', - - constraint primary key (group_id, blocked) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table group_alias ( - - alias varchar(64) primary key comment 'additional nickname for the group', - group_id integer not null comment 'group profile is blocked from' references user_group (id), - modified timestamp comment 'date alias was created', - - index group_alias_group_id_idx (group_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table session ( - - id varchar(32) primary key comment 'session ID', - session_data text comment 'session data', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - index session_modified_idx (modified) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table deleted_notice ( - - id integer primary key comment 'identity of notice', - profile_id integer not null comment 'author of the notice', - uri varchar(255) unique key comment 'universally unique identifier, usually a tag URI', - created datetime not null comment 'date the notice record was created', - deleted datetime not null comment 'date the notice record was created', - - index deleted_notice_profile_id_idx (profile_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table config ( - - section varchar(32) comment 'configuration section', - setting varchar(32) comment 'configuration setting', - value varchar(255) comment 'configuration value', - - constraint primary key (section, setting) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table profile_role ( - - profile_id integer not null comment 'account having the role' references profile (id), - role varchar(32) not null comment 'string representing the role', - created datetime not null comment 'date the role was granted', - - constraint primary key (profile_id, role), - index profile_role_role_created_profile_id_idx (role, created, profile_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table location_namespace ( - - id integer primary key comment 'identity for this namespace', - description varchar(255) comment 'description of the namespace', - created datetime not null comment 'date the record was created', - modified timestamp comment 'date this record was modified' - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table login_token ( - user_id integer not null comment 'user owning this token' references user (id), - token char(32) not null comment 'token useable for logging in', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (user_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table user_location_prefs ( - user_id integer not null comment 'user who has the preference' references user (id), - share_location tinyint default 1 comment 'Whether to share location data', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (user_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table inbox ( - - user_id integer not null comment 'user receiving the notice' references user (id), - notice_ids blob comment 'packed list of notice ids', - - constraint primary key (user_id) - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table user_im_prefs ( - user_id integer not null comment 'user' references user (id), - screenname varchar(255) not null comment 'screenname on this service', - transport varchar(255) not null comment 'transport (ex xmpp, aim)', - notify tinyint(1) not null default 0 comment 'Notify when a new notice is sent', - replies tinyint(1) not null default 0 comment 'Send replies from people not subscribed to', - microid tinyint(1) not null default 1 comment 'Publish a MicroID', - updatefrompresence tinyint(1) not null default 0 comment 'Send replies from people not subscribed to.', - created timestamp not null DEFAULT CURRENT_TIMESTAMP comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (user_id, transport), - constraint unique key `transport_screenname_key` ( `transport` , `screenname` ) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table conversation ( - id integer auto_increment primary key comment 'unique identifier', - uri varchar(225) unique comment 'URI of the conversation', - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table local_group ( - - group_id integer primary key comment 'group represented' references user_group (id), - nickname varchar(64) unique key comment 'group represented', - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified' - -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; - -create table user_urlshortener_prefs ( - - user_id integer not null comment 'user' references user (id), - urlshorteningservice varchar(50) default 'ur1.ca' comment 'service to use for auto-shortening URLs', - maxurllength integer not null comment 'urls greater than this length will be shortened, 0 = always, null = never', - maxnoticelength integer not null comment 'notices with content greater than this value will have all urls shortened, 0 = always, null = never', - - created datetime not null comment 'date this record was created', - modified timestamp comment 'date this record was modified', - - constraint primary key (user_id) -) ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin; diff --git a/db/statusnet_pg.sql b/db/statusnet_pg.sql deleted file mode 100644 index fe0758de89..0000000000 --- a/db/statusnet_pg.sql +++ /dev/null @@ -1,649 +0,0 @@ -/* local and remote users have profiles */ -create sequence profile_seq; -create table profile ( - id bigint default nextval('profile_seq') primary key /* comment 'unique identifier' */, - nickname varchar(64) not null /* comment 'nickname or username' */, - fullname varchar(255) /* comment 'display name' */, - profileurl varchar(255) /* comment 'URL, cached so we dont regenerate' */, - homepage varchar(255) /* comment 'identifying URL' */, - bio varchar(140) /* comment 'descriptive biography' */, - location varchar(255) /* comment 'physical location' */, - lat decimal(10,7) /* comment 'latitude'*/ , - lon decimal(10,7) /* comment 'longitude'*/ , - location_id integer /* comment 'location id if possible'*/ , - location_ns integer /* comment 'namespace for location'*/ , - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */, - - textsearch tsvector -); -create index profile_nickname_idx on profile using btree(nickname); - -create table avatar ( - profile_id integer not null /* comment 'foreign key to profile table' */ references profile (id) , - original integer default 0 /* comment 'uploaded by user or generated?' */, - width integer not null /* comment 'image width' */, - height integer not null /* comment 'image height' */, - mediatype varchar(32) not null /* comment 'file type' */, - filename varchar(255) null /* comment 'local filename, if local' */, - url varchar(255) unique /* comment 'avatar location' */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */, - - primary key(profile_id, width, height) -); -create index avatar_profile_id_idx on avatar using btree(profile_id); - -create sequence sms_carrier_seq; -create table sms_carrier ( - id bigint default nextval('sms_carrier_seq') primary key /* comment 'primary key for SMS carrier' */, - name varchar(64) unique /* comment 'name of the carrier' */, - email_pattern varchar(255) not null /* comment 'sprintf pattern for making an email address from a phone number' */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified ' */ -); - -create sequence design_seq; -create table design ( - id bigint default nextval('design_seq') /* comment 'design ID'*/, - backgroundcolor integer /* comment 'main background color'*/ , - contentcolor integer /*comment 'content area background color'*/ , - sidebarcolor integer /*comment 'sidebar background color'*/ , - textcolor integer /*comment 'text color'*/ , - linkcolor integer /*comment 'link color'*/, - backgroundimage varchar(255) /*comment 'background image, if any'*/, - disposition int default 1 /*comment 'bit 1 = hide background image, bit 2 = display background image, bit 4 = tile background image'*/, - primary key (id) -); - -/* local users */ - -create table "user" ( - id integer primary key /* comment 'foreign key to profile table' */ references profile (id) , - nickname varchar(64) unique /* comment 'nickname or username, duped in profile' */, - password varchar(255) /* comment 'salted password, can be null for OpenID users' */, - email varchar(255) unique /* comment 'email address for password recovery etc.' */, - incomingemail varchar(255) unique /* comment 'email address for post-by-email' */, - emailnotifysub integer default 1 /* comment 'Notify by email of subscriptions' */, - emailnotifyfav integer default 1 /* comment 'Notify by email of favorites' */, - emailnotifynudge integer default 1 /* comment 'Notify by email of nudges' */, - emailnotifymsg integer default 1 /* comment 'Notify by email of direct messages' */, - emailnotifyattn integer default 1 /* command 'Notify by email of @-replies' */, - emailmicroid integer default 1 /* comment 'whether to publish email microid' */, - language varchar(50) /* comment 'preferred language' */, - timezone varchar(50) /* comment 'timezone' */, - emailpost integer default 1 /* comment 'Post by email' */, - jabber varchar(255) unique /* comment 'jabber ID for notices' */, - jabbernotify integer default 0 /* comment 'whether to send notices to jabber' */, - jabberreplies integer default 0 /* comment 'whether to send notices to jabber on replies' */, - jabbermicroid integer default 1 /* comment 'whether to publish xmpp microid' */, - updatefrompresence integer default 0 /* comment 'whether to record updates from Jabber presence notices' */, - sms varchar(64) unique /* comment 'sms phone number' */, - carrier integer /* comment 'foreign key to sms_carrier' */ references sms_carrier (id) , - smsnotify integer default 0 /* comment 'whether to send notices to SMS' */, - smsreplies integer default 0 /* comment 'whether to send notices to SMS on replies' */, - smsemail varchar(255) /* comment 'built from sms and carrier' */, - uri varchar(255) unique /* comment 'universally unique identifier, usually a tag URI' */, - autosubscribe integer default 0 /* comment 'automatically subscribe to users who subscribe to us' */, - urlshorteningservice varchar(50) default 'ur1.ca' /* comment 'service to use for auto-shortening URLs' */, - inboxed integer default 0 /* comment 'has an inbox been created for this user?' */, - design_id integer /* comment 'id of a design' */references design(id), - viewdesigns integer default 1 /* comment 'whether to view user-provided designs'*/, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */ - -); -create index user_smsemail_idx on "user" using btree(smsemail); - -/* remote people */ - -create table remote_profile ( - id integer primary key /* comment 'foreign key to profile table' */ references profile (id) , - uri varchar(255) unique /* comment 'universally unique identifier, usually a tag URI' */, - postnoticeurl varchar(255) /* comment 'URL we use for posting notices' */, - updateprofileurl varchar(255) /* comment 'URL we use for updates to this profile' */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */ -); - -create table subscription ( - subscriber integer not null /* comment 'profile listening' */, - subscribed integer not null /* comment 'profile being listened to' */, - jabber integer default 1 /* comment 'deliver jabber messages' */, - sms integer default 1 /* comment 'deliver sms messages' */, - token varchar(255) /* comment 'authorization token' */, - secret varchar(255) /* comment 'token secret' */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */, - - primary key (subscriber, subscribed) -); -create index subscription_subscriber_idx on subscription using btree(subscriber,created); -create index subscription_subscribed_idx on subscription using btree(subscribed,created); - -create sequence notice_seq; -create table notice ( - - id bigint default nextval('notice_seq') primary key /* comment 'unique identifier' */, - profile_id integer not null /* comment 'who made the update' */ references profile (id) , - uri varchar(255) unique /* comment 'universally unique identifier, usually a tag URI' */, - content varchar(140) /* comment 'update content' */, - rendered text /* comment 'HTML version of the content' */, - url varchar(255) /* comment 'URL of any attachment (image, video, bookmark, whatever)' */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */, - reply_to integer /* comment 'notice replied to (usually a guess)' */ references notice (id) , - is_local integer default 0 /* comment 'notice was generated by a user' */, - source varchar(32) /* comment 'source of comment, like "web", "im", or "clientname"' */, - conversation integer /*id of root notice in this conversation' */ references notice (id), - lat decimal(10,7) /* comment 'latitude'*/ , - lon decimal(10,7) /* comment 'longitude'*/ , - location_id integer /* comment 'location id if possible'*/ , - location_ns integer /* comment 'namespace for location'*/ , - repeat_of integer /* comment 'notice this is a repeat of' */ references notice (id) - -/* FULLTEXT(content) */ -); - -create index notice_profile_id_idx on notice using btree(profile_id,created,id); -create index notice_created_idx on notice using btree(created); - -create table notice_source ( - code varchar(32) primary key not null /* comment 'source code' */, - name varchar(255) not null /* comment 'name of the source' */, - url varchar(255) not null /* comment 'url to link to' */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */ -); - -create table reply ( - - notice_id integer not null /* comment 'notice that is the reply' */ references notice (id) , - profile_id integer not null /* comment 'profile replied to' */ references profile (id) , - modified timestamp /* comment 'date this record was modified' */, - replied_id integer /* comment 'notice replied to (not used, see notice.reply_to)' */, - - primary key (notice_id, profile_id) - -); -create index reply_notice_id_idx on reply using btree(notice_id); -create index reply_profile_id_idx on reply using btree(profile_id); -create index reply_replied_id_idx on reply using btree(replied_id); - -create table fave ( - - notice_id integer not null /* comment 'notice that is the favorite' */ references notice (id), - user_id integer not null /* comment 'user who likes this notice' */ references "user" (id) , - modified timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was modified' */, - primary key (notice_id, user_id) - -); -create index fave_notice_id_idx on fave using btree(notice_id); -create index fave_user_id_idx on fave using btree(user_id,modified); -create index fave_modified_idx on fave using btree(modified); - -/* tables for OAuth */ - -create table consumer ( - consumer_key varchar(255) primary key /* comment 'unique identifier, root URL' */, - consumer_secret varchar(255) not null /* comment 'secret value', */, - seed char(32) not null /* comment 'seed for new tokens by this consumer' */, - - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */ -); - -create table token ( - consumer_key varchar(255) not null /* comment 'unique identifier, root URL' */ references consumer (consumer_key), - tok char(32) not null /* comment 'identifying value' */, - secret char(32) not null /* comment 'secret value' */, - type integer not null default 0 /* comment 'request or access' */, - state integer default 0 /* comment 'for requests 0 = initial, 1 = authorized, 2 = used' */, - - verifier varchar(255) /*comment 'verifier string for OAuth 1.0a'*/, - verified_callback varchar(255) /*comment 'verified callback URL for OAuth 1.0a'*/, - - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */, - - primary key (consumer_key, tok) -); - -create table nonce ( - consumer_key varchar(255) not null /* comment 'unique identifier, root URL' */, - tok char(32) /* comment 'buggy old value, ignored' */, - nonce char(32) null /* comment 'buggy old value, ignored */, - ts integer not null /* comment 'timestamp sent' values are epoch, and only used internally */, - - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */, - - primary key (consumer_key, ts, nonce) -); - -create sequence oauth_application_seq; -create table oauth_application ( - id bigint default nextval('oauth_application_seq') primary key /* comment 'unique identifier' */, - owner integer not null /* comment 'owner of the application' */ references profile (id), - consumer_key varchar(255) not null /* comment 'application consumer key' */ references consumer (consumer_key), - name varchar(255) unique not null /* comment 'name of the application' */, - description varchar(255) /* comment 'description of the application' */, - icon varchar(255) not null /* comment 'application icon' */, - source_url varchar(255) /* comment 'application homepage - used for source link' */, - organization varchar(255) /* comment 'name of the organization running the application' */, - homepage varchar(255) /* comment 'homepage for the organization' */, - callback_url varchar(255) /* comment 'url to redirect to after authentication' */, - "type" integer default 0 /* comment 'type of app, 1 = browser, 2 = desktop' */, - access_type integer default 0 /* comment 'default access type, bit 1 = read, bit 2 = write' */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */ -); - -create table oauth_application_user ( - profile_id integer not null /* 'user of the application' */ references profile (id), - application_id integer not null /* 'id of the application' */ references oauth_application (id), - access_type integer default 0 /* 'access type, bit 1 = read, bit 2 = write' */, - token varchar(255) /* 'request or access token' */, - created timestamp not null default CURRENT_TIMESTAMP /* 'date this record was created' */, - modified timestamp /* 'date this record was modified' */, - primary key (profile_id, application_id) -); - -/* These are used by JanRain OpenID library */ - -create table oid_associations ( - server_url varchar(2047), - handle varchar(255), - secret bytea, - issued integer, - lifetime integer, - assoc_type varchar(64), - primary key (server_url, handle) -); - -create table oid_nonces ( - server_url varchar(2047), - "timestamp" integer, - salt character(40), - unique (server_url, "timestamp", salt) -); - -create table confirm_address ( - code varchar(32) not null primary key /* comment 'good random code' */, - user_id integer not null /* comment 'user who requested confirmation' */ references "user" (id), - address varchar(255) not null /* comment 'address (email, Jabber, SMS, etc.)' */, - address_extra varchar(255) not null default '' /* comment 'carrier ID, for SMS' */, - address_type varchar(8) not null /* comment 'address type ("email", "jabber", "sms")' */, - claimed timestamp /* comment 'date this was claimed for queueing' */, - sent timestamp default CURRENT_TIMESTAMP /* comment 'date this was sent for queueing' */, - modified timestamp /* comment 'date this record was modified' */ -); - -create table remember_me ( - code varchar(32) not null primary key /* comment 'good random code' */, - user_id integer not null /* comment 'user who is logged in' */ references "user" (id), - modified timestamp /* comment 'date this record was modified' */ -); - -create table queue_item ( - id serial /* comment 'unique identifier'*/, - frame bytea not null /* comment 'data: object reference or opaque string'*/, - transport varchar(8) not null /*comment 'queue for what? "email", "jabber", "sms", "irc", ...'*/, - created timestamp not null default CURRENT_TIMESTAMP /*comment 'date this record was created'*/, - claimed timestamp /*comment 'date this item was claimed'*/, - PRIMARY KEY (id) -); -create index queue_item_created_idx on queue_item using btree(created); - -/* Hash tags */ -create table notice_tag ( - tag varchar( 64 ) not null /* comment 'hash tag associated with this notice' */, - notice_id integer not null /* comment 'notice tagged' */ references notice (id) , - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - - primary key (tag, notice_id) -); -create index notice_tag_created_idx on notice_tag using btree(created); - -/* Synching with foreign services */ - -create table foreign_service ( - id int not null primary key /* comment 'numeric key for service' */, - name varchar(32) not null unique /* comment 'name of the service' */, - description varchar(255) /* comment 'description' */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */ -); - -create table foreign_user ( - id int not null unique /* comment 'unique numeric key on foreign service' */, - service int not null /* comment 'foreign key to service' */ references foreign_service(id) , - uri varchar(255) not null unique /* comment 'identifying URI' */, - nickname varchar(255) /* comment 'nickname on foreign service' */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */, - - primary key (id, service) -); - -create table foreign_link ( - user_id int /* comment 'link to user on this system, if exists' */ references "user" (id), - foreign_id int /* comment 'link' */ references foreign_user (id), - service int not null /* comment 'foreign key to service' */ references foreign_service (id), - credentials varchar(255) /* comment 'authc credentials, typically a password' */, - noticesync int not null default 1 /* comment 'notice synchronisation, bit 1 = sync outgoing, bit 2 = sync incoming, bit 3 = filter local replies' */, - friendsync int not null default 2 /* comment 'friend synchronisation, bit 1 = sync outgoing, bit 2 = sync incoming */, - profilesync int not null default 1 /* comment 'profile synchronization, bit 1 = sync outgoing, bit 2 = sync incoming' */, - last_noticesync timestamp default null /* comment 'last time notices were imported' */, - last_friendsync timestamp default null /* comment 'last time friends were imported' */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */, - - primary key (user_id,foreign_id,service) -); -create index foreign_user_user_id_idx on foreign_link using btree(user_id); - -create table foreign_subscription ( - service int not null /* comment 'service where relationship happens' */ references foreign_service(id) , - subscriber int not null /* comment 'subscriber on foreign service' */ , - subscribed int not null /* comment 'subscribed user' */ , - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - - primary key (service, subscriber, subscribed) -); -create index foreign_subscription_subscriber_idx on foreign_subscription using btree(subscriber); -create index foreign_subscription_subscribed_idx on foreign_subscription using btree(subscribed); - -create table invitation ( - code varchar(32) not null primary key /* comment 'random code for an invitation' */, - user_id int not null /* comment 'who sent the invitation' */ references "user" (id), - address varchar(255) not null /* comment 'invitation sent to' */, - address_type varchar(8) not null /* comment 'address type ("email", "jabber", "sms") '*/, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */ - -); -create index invitation_address_idx on invitation using btree(address,address_type); -create index invitation_user_id_idx on invitation using btree(user_id); - -create sequence message_seq; -create table message ( - - id bigint default nextval('message_seq') primary key /* comment 'unique identifier' */, - uri varchar(255) unique /* comment 'universally unique identifier' */, - from_profile integer not null /* comment 'who the message is from' */ references profile (id), - to_profile integer not null /* comment 'who the message is to' */ references profile (id), - content varchar(140) /* comment 'message content' */, - rendered text /* comment 'HTML version of the content' */, - url varchar(255) /* comment 'URL of any attachment (image, video, bookmark, whatever)' */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */, - source varchar(32) /* comment 'source of comment, like "web", "im", or "clientname"' */ - -); -create index message_from_idx on message using btree(from_profile); -create index message_to_idx on message using btree(to_profile); -create index message_created_idx on message using btree(created); - -create table notice_inbox ( - - user_id integer not null /* comment 'user receiving the message' */ references "user" (id), - notice_id integer not null /* comment 'notice received' */ references notice (id), - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date the notice was created' */, - source integer default 1 /* comment 'reason it is in the inbox: 1=subscription' */, - - primary key (user_id, notice_id) -); -create index notice_inbox_notice_id_idx on notice_inbox using btree(notice_id); - -create table profile_tag ( - tagger integer not null /* comment 'user making the tag' */ references "user" (id), - tagged integer not null /* comment 'profile tagged' */ references profile (id), - tag varchar(64) not null /* comment 'hash tag associated with this notice' */, - modified timestamp /* comment 'date the tag was added' */, - - primary key (tagger, tagged, tag) -); -create index profile_tag_modified_idx on profile_tag using btree(modified); -create index profile_tag_tagger_tag_idx on profile_tag using btree(tagger,tag); - -create table profile_block ( - - blocker integer not null /* comment 'user making the block' */ references "user" (id), - blocked integer not null /* comment 'profile that is blocked' */ references profile (id), - modified timestamp /* comment 'date of blocking' */, - - primary key (blocker, blocked) - -); - -create sequence user_group_seq; -create table user_group ( - - id bigint default nextval('user_group_seq') primary key /* comment 'unique identifier' */, - - nickname varchar(64) unique /* comment 'nickname for addressing' */, - fullname varchar(255) /* comment 'display name' */, - homepage varchar(255) /* comment 'URL, cached so we dont regenerate' */, - description varchar(140) /* comment 'descriptive biography' */, - location varchar(255) /* comment 'related physical location, if any' */, - - original_logo varchar(255) /* comment 'original size logo' */, - homepage_logo varchar(255) /* comment 'homepage (profile) size logo' */, - stream_logo varchar(255) /* comment 'stream-sized logo' */, - mini_logo varchar(255) /* comment 'mini logo' */, - design_id integer /*comment 'id of a design' */ references design(id), - - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */ - -); -create index user_group_nickname_idx on user_group using btree(nickname); - -create table group_member ( - - group_id integer not null /* comment 'foreign key to user_group' */ references user_group (id), - profile_id integer not null /* comment 'foreign key to profile table' */ references profile (id), - is_admin integer default 0 /* comment 'is this user an admin?' */, - - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */, - - primary key (group_id, profile_id) -); - -create table related_group ( - - group_id integer not null /* comment 'foreign key to user_group' */ references user_group (id) , - related_group_id integer not null /* comment 'foreign key to user_group' */ references user_group (id), - - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date this record was created' */, - - primary key (group_id, related_group_id) - -); - -create table group_inbox ( - group_id integer not null /* comment 'group receiving the message' references user_group (id) */, - notice_id integer not null /* comment 'notice received' references notice (id) */, - created timestamp not null default CURRENT_TIMESTAMP /* comment 'date the notice was created' */, - primary key (group_id, notice_id) -); -create index group_inbox_created_idx on group_inbox using btree(created); - -/*attachments and URLs stuff */ -create sequence file_seq; -create table file ( - id bigint default nextval('file_seq') primary key /* comment 'unique identifier' */, - url varchar(255) unique, - mimetype varchar(50), - size integer, - title varchar(255), - date integer, - protected integer, - filename text /* comment 'if a local file, name of the file' */, - modified timestamp default CURRENT_TIMESTAMP /* comment 'date this record was modified'*/ -); - -create sequence file_oembed_seq; -create table file_oembed ( - file_id bigint default nextval('file_oembed_seq') primary key /* comment 'unique identifier' */, - version varchar(20), - type varchar(20), - mimetype varchar(50), - provider varchar(50), - provider_url varchar(255), - width integer, - height integer, - html text, - title varchar(255), - author_name varchar(50), - author_url varchar(255), - url varchar(255) -); - -create sequence file_redirection_seq; -create table file_redirection ( - url varchar(255) primary key, - file_id bigint, - redirections integer, - httpcode integer -); - -create sequence file_thumbnail_seq; -create table file_thumbnail ( - file_id bigint primary key, - url varchar(255) unique, - width integer, - height integer -); - -create sequence file_to_post_seq; -create table file_to_post ( - file_id bigint, - post_id bigint, - - primary key (file_id, post_id) -); - -create table group_block ( - group_id integer not null /* comment 'group profile is blocked from' */ references user_group (id), - blocked integer not null /* comment 'profile that is blocked' */references profile (id), - blocker integer not null /* comment 'user making the block'*/ references "user" (id), - modified timestamp /* comment 'date of blocking'*/ , - - primary key (group_id, blocked) -); - -create table group_alias ( - - alias varchar(64) /* comment 'additional nickname for the group'*/ , - group_id integer not null /* comment 'group profile is blocked from'*/ references user_group (id), - modified timestamp /* comment 'date alias was created'*/, - primary key (alias) - -); -create index group_alias_group_id_idx on group_alias (group_id); - -create table session ( - - id varchar(32) primary key /* comment 'session ID'*/, - session_data text /* comment 'session data'*/, - created timestamp not null DEFAULT CURRENT_TIMESTAMP /* comment 'date this record was created'*/, - modified integer DEFAULT extract(epoch from CURRENT_TIMESTAMP) /* comment 'date this record was modified'*/ -); - -create index session_modified_idx on session (modified); - -create table deleted_notice ( - - id integer primary key /* comment 'identity of notice'*/ , - profile_id integer /* not null comment 'author of the notice'*/, - uri varchar(255) unique /* comment 'universally unique identifier, usually a tag URI'*/, - created timestamp not null /* comment 'date the notice record was created'*/ , - deleted timestamp not null DEFAULT CURRENT_TIMESTAMP /* comment 'date the notice record was created'*/ -); - -CREATE index deleted_notice_profile_id_idx on deleted_notice (profile_id); - -/* Textsearch stuff */ - -create index textsearch_idx on profile using gist(textsearch); -create index noticecontent_idx on notice using gist(to_tsvector('english',content)); -create trigger textsearchupdate before insert or update on profile for each row -execute procedure tsvector_update_trigger(textsearch, 'pg_catalog.english', nickname, fullname, location, bio, homepage); - -create table config ( - - section varchar(32) /* comment 'configuration section'*/, - setting varchar(32) /* comment 'configuration setting'*/, - value varchar(255) /* comment 'configuration value'*/, - - primary key (section, setting) - -); - -create table profile_role ( - - profile_id integer not null /* comment 'account having the role'*/ references profile (id), - role varchar(32) not null /* comment 'string representing the role'*/, - created timestamp /* not null comment 'date the role was granted'*/, - - primary key (profile_id, role) - -); - -create table location_namespace ( - - id integer /*comment 'identity for this namespace'*/, - description text /* comment 'description of the namespace'*/ , - created integer not null /*comment 'date the record was created*/ , - /* modified timestamp comment 'date this record was modified',*/ - primary key (id) - -); - -create table login_token ( - user_id integer not null /* comment 'user owning this token'*/ references "user" (id), - token char(32) not null /* comment 'token useable for logging in'*/, - created timestamp not null DEFAULT CURRENT_TIMESTAMP /* comment 'date this record was created'*/, - modified timestamp /* comment 'date this record was modified'*/, - - primary key (user_id) -); - -create table user_location_prefs ( - user_id integer not null /* comment 'user who has the preference' */ references "user" (id), - share_location integer default 1 /* comment 'Whether to share location data' */, - created timestamp not null DEFAULT CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */, - - primary key (user_id) -); - -create table inbox ( - - user_id integer not null /* comment 'user receiving the notice' */ references "user" (id), - notice_ids bytea /* comment 'packed list of notice ids' */, - - primary key (user_id) - -); - -create sequence conversation_seq; -create table conversation ( - id bigint default nextval('conversation_seq') primary key /* comment 'unique identifier' */, - uri varchar(225) unique /* comment 'URI of the conversation' */, - created timestamp not null DEFAULT CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */ -); - -create table local_group ( - - group_id integer primary key /* comment 'group represented' */ references user_group (id), - nickname varchar(64) unique /* comment 'group represented' */, - - created timestamp not null DEFAULT CURRENT_TIMESTAMP /* comment 'date this record was created' */, - modified timestamp /* comment 'date this record was modified' */ - -); - diff --git a/install.php b/install.php index 5cb46e27d2..054be3d8d7 100644 --- a/install.php +++ b/install.php @@ -248,6 +248,20 @@ class WebInstaller extends Installer +
+ Site profile +
    +
  • + + +

    Initial access settings for your site

    +
    • +
+
@@ -284,7 +298,7 @@ STR; /** * Read and validate input data. * May output side effects. - * + * * @return boolean success */ function prepare() @@ -304,6 +318,8 @@ STR; $this->adminEmail = $post->string('admin_email'); $this->adminUpdates = $post->string('admin_updates'); + $this->siteProfile = $post->string('site_profile'); + $this->server = $_SERVER['HTTP_HOST']; $this->path = substr(dirname($_SERVER['PHP_SELF']), 1); @@ -315,12 +331,16 @@ STR; if (!$this->validateAdmin()) { $fail = true; } - + if ($this->adminPass != $adminPass2) { $this->updateStatus("Administrator passwords do not match. Did you mistype?", true); $fail = true; } - + + if (!$this->validateSiteProfile()) { + $fail = true; + } + return !$fail; } @@ -359,11 +379,11 @@ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"