+++ /dev/null
-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/<servername>.php - for a virtual host
-* /etc/statusnet/<servername>_<pathname>.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'.
-sslproxy: Whether to force GNUsocial to think it is HTTPS when the
- server gives no such information. I.e. when you're using a reverse
- proxy that adds the encryption layer but the webserver that runs PHP
- isn't configured with a key and certificate.
-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
-<http://pear.php.net/manual/en/package.database.db-dataobject.intro-configuration.php>).
-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.
-daemon: Wather to use queuedaemon. Defaults to false, which means
- you'll use OpportunisticQM plugin.
-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 <group>/<queue> or <group>/<queue>/<site>,
- 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 <https://www.w3.org/Protocols/rfc2616/rfc2616-sec8.html#sec8.1.4>,
- 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. 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.
-
-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 false.
-restore: whether users can restore their profiles from backup files. Defaults
- to false.
-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.
-
-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).
-
-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).
-
-process_links: follow redirects and save all available file information
- (mimetype, date, size, oembed, etc.). Defaults to true.
-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.
-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.
-show_thumbs: show thumbnails in notice lists for uploaded images, and photos
- and videos linked remotely that provide oEmbed info. Defaults to true.
-show_html: show (filtered) text/html attachments (and oEmbed HTML etc.).
- Doesn't affect AJAX calls. Defaults to false.
-filename_base: for new files, choose one: 'upload', 'hash'. Defaults to hash.
-
-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.
-
-search
-------
-
-Some stuff for search.
-
-type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
- be 'fulltext' or 'like' (default). 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 cache layers 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.
-
-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).
-
-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 <https://en.wikipedia.org/wiki/Robots_exclusion_standard#Crawl-delay_directive>
- 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
----
-
-These are some options for fine-tuning how and when the server will
-shorten URLs.
-
-shortener: URL shortening service to use by default. Users can override
- individually. 'internal' by default.
-maxurllength: 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 100. 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 cache layers. 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 developing..
-
-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 <http://curl.haxx.se/> 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.
-
-performance
------------
-
-high: if you need high performance, or if you're seeing bad
- performance, set this to true. It will turn off some high-intensity code from
- the site.
-
-cache
------
-
-dir: A string path to a writable directory that will be used as temporary cache
- for some functions (currently just the HtmlSanitizer).
- If it is not set, the GNU social installation directory will be used.
-
-oldschool
----------
-
-enabled: enable certain old-style user settings options, like stream-only mode,
- conversation trees, and nicknames in streams. Off by default, and
- may not be well supported in future versions.
--- /dev/null
+InitializePlugin: a chance to initialize a plugin in a complete environment
+
+CleanupPlugin: a chance to cleanup a plugin at the end of a program
+
+StartActionExecute: Right before the "prepare" call of the current Action
+- $action: the current Action object
+- &$args: array of arguments, referenced so you can modify the array
+
+EndActionExecute: Right after the "handle" call of the current Action
+- $action: the current Action object
+
+StartPrimaryNav: Showing the primary nav menu
+- $action: the current action
+
+EndPrimaryNav: At the end of the primary nav menu
+- $action: the current action
+
+StartSecondaryNav: Showing the secondary nav menu
+- $action: the current action
+
+EndSecondaryNav: At the end of the secondary nav menu
+- $action: the current action
+
+StartShowStyles: Showing Style links; good place to add UA style resets
+- $action: the current action
+
+EndShowStyles: End showing Style links; good place to add custom styles
+- $action: the current action
+
+StartShowStylesheets: Showing stylesheet links
+- $action: the current action
+
+EndShowStylesheets: End showing stylesheet links; good place to add handheld or JavaScript dependant styles
+- $action: the current action
+
+StartShowUAStyles: Showing custom User-Agent style links
+- $action: the current action
+
+EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
+- $action: the current action
+
+StartShowScripts: Showing JavaScript links
+- $action: the current action
+
+EndShowScripts: End showing JavaScript links; good place to add custom links
+- $action: the current action
+
+StartShowJQueryScripts: Showing JQuery script links
+- $action: the current action
+
+EndShowJQueryScripts: End showing JQuery script links
+- $action: the current action
+
+StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
+- $action: the current action
+
+EndShowStatusNetScripts: End showing StatusNet script links
+- $action: the current action
+
+StartShowSections: Start the list of sections in the sidebar
+- $action: the current action
+
+EndShowSections: End the list of sections in the sidebar
+- $action: the current action
+
+StartShowHeader: Showing before the header container
+- $action: the current action
+
+EndShowHeader: Showing after the header container
+- $action: the current action
+
+StartShowFooter: Showing before the footer container
+- $action: the current action
+
+EndShowFooter: Showing after the footer container
+- $action: the current action
+
+StartShowContentBlock: Showing before the content container
+- $action: the current action
+
+EndShowContentBlock: Showing after the content container
+- $action: the current action
+
+StartShowAside: Showing before the Aside container
+- $action: the current action
+
+EndShowAside: Showing after the Aside container
+- $action: the current action
+
+StartShowNoticeFormData: Showing before the notice form data
+- $action: the current action
+
+EndShowNoticeFormData: Showing after the notice form data
+- $action: the current action
+
+StartNoticeSave: before inserting a notice (good place for content filters)
+- $notice: notice being saved (no ID or URI)
+
+EndNoticeSave: after inserting a notice and related code
+- $notice: notice that was saved (with ID and URI)
+
+StartShowLocalNavBlock: Showing the local nav menu
+- $action: the current action
+
+EndShowLocalNavBlock: At the end of the local nav menu
+- $action: the current action
+
+StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
+- $action: the current action
+
+EndShowHTML: Showing after the html element
+- $action: the current action
+
+StartPublicGroupNav: Showing the public group nav menu
+- $menu: the menu widget; use $menu->action for output
+
+EndPublicGroupNav: At the end of the public group nav menu
+- $menu: the menu widget; use $menu->action for output
+
+StartSubGroupNav: Showing the subscriptions group nav menu
+- $menu: the menu widget; use $menu->action for output
+
+EndSubGroupNav: At the end of the subscriptions group nav menu
+- $menu: the menu widget; use $menu->action for output
+
+StartInitializeRouter: Before the router instance has been initialized; good place to add routes
+- $m: the Net_URL_Mapper that has just been set up
+
+RouterInitialized: After the router instance has been initialized
+- $m: the Net_URL_Mapper that has just been set up
+
+StartLogout: Before logging out
+- $action: the logout action
+
+EndLogout: After logging out
+- $action: the logout action
+
+ArgsInitialize: After the argument array has been initialized
+- $args: associative array of arguments, can be modified
+
+StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
+- $action: the current action
+
+EndAddressData: At the end of <address>
+- $action: the current action
+
+StartShowSiteNotice: Before showing site notice
+- $action: the current action
+
+EndShowSiteNotice: After showing site notice
+- $action: the current action
+
+StartLoginGroupNav: Before showing the login and register navigation menu
+- $action: the current action
+
+EndLoginGroupNav: After showing the login and register navigation menu
+- $action: the current action
+
+StartAccountSettingsNav: Before showing the account settings menu
+- $action: the current action
+
+EndAccountSettingsNav: After showing the account settings menu
+- $action: the current action
+
+StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsProfileMenuItem: After showing the Profile menu item
+- $widget: AccountSettingsNav instance being shown
+
+StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
+- $widget: AccountSettingsNav instance being shown
+
+StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsPasswordMenuItem: After showing the Password menu item
+- $widget: AccountSettingsNav instance being shown
+
+StartAccountSettingsEmailMenuItem: Before showing the Email menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsEmailMenuItem: After showing the Email menu item
+- $widget: AccountSettingsNav instance being shown
+
+StartAccountSettingsDesignMenuItem: Before showing the Design menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsDesignMenuItem: After showing the Design menu item
+- $widget: AccountSettingsNav instance being shown
+
+StartAccountSettingsOtherMenuItem: Before showing the Other menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsOtherMenuItem: After showing the Other menu item
+- $widget: AccountSettingsNav instance being shown
+
+Autoload: When trying to autoload a class
+- $cls: the class being sought. A plugin might require_once the file for the class.
+
+SensitiveAction: determines if an action is 'sensitive' and should use SSL
+- $action: name of the action, like 'login'
+- $sensitive: flag for whether this is a sensitive action
+
+LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
+- $action: name of the action, like 'register'
+- $login: flag for whether this is a login action
+
+StartShowHead: called before showing the <head> element and children
+- $action: action object being show
+
+EndShowHead: called after showing the <head> element (and </head>)
+- $action: action object being shown
+
+StartShowBody: called before showing the <body> element and children
+- $action: action object being shown
+
+EndShowBody: called after showing the <body> element (and </body>)
+- $action: action object being shown
+
+StartPersonalGroupNav: beginning of personal group nav menu
+- $menu: Menu list object being shown
+- $target: Profile for whom it is shown
+- $scoped: Profile of currently logged in user (or null)
+
+EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
+- $action: action object being shown
+
+StartGroupGroupNav: Showing the group nav menu
+- $action: the current action
+
+EndGroupGroupNav: At the end of the group nav menu
+- $action: the current action
+
+StartEndHTML: just before the </html> tag
+- $action: action object being shown
+
+EndEndHTML: just after the </html> tag
+- $action: action object being shown
+
+FinalAction: After prepare() (and possible handle) in Action class.
+- $status: result of "prepare" call on action
+- $action: Action that is currently running
+
+StartShowDesign: just before showing a site, user, or group design
+- $action: action object being shown
+
+EndShowDesign: just after showing a site, user, or group design
+- $action: action object being shown
+
+StartShowExportData: just before showing the <div> with export data (feeds)
+- $action: action object being shown
+
+EndShowExportData: just after showing the <div> with export data (feeds)
+- $action: action object being shown
+
+StartShowNoticeItem: just before showing the notice item
+- $item: The NoticeListItem object being shown
+
+EndShowNoticeItem: just after showing the notice item
+- $item: the NoticeListItem object being shown
+
+StartShowNoticeItemNotice: just before outputting the "top" notice part of a NoticeListItem to HTML
+- $item: The NoticeListItem object being shown
+
+EndShowNoticeItemNotice: just after outputting the "top" notice part of a NoticeListItem to HTML
+- $item: The NoticeListItem object being shown
+
+StartShowNoticeContent: just before outputting the content part of a Notice
+- $stored: The Notice object
+- $out: HTMLOutputter for writing to
+- $scoped: optional Profile object for permission scoping
+
+EndShowNoticeContent: just after outputting the content part of a Notice, plugins must call this manually
+- $stored: The Notice object
+- $out: HTMLOutputter for writing to
+- $scoped: optional Profile object for permission scoping
+
+StartShowNoticeInfo: just before showing notice info
+- $item: The NoticeListItem object being shown
+
+EndShowNoticeInfo: just after showing notice info
+- $item: The NoticeListItem object being shown
+
+StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.
+- $item: the NoticeListItem object being shown
+
+EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
+- $item: the NoticeListItem object being shown
+
+StartShowPageNotice: just before showing the page notice (instructions or error)
+- $action: action object being shown
+
+EndShowPageNotice: just after showing the page notice (instructions or error)
+- $action: action object being shown
+
+StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
+- $action: action object being shown
+
+StartProfileFormData: just before showing text entry fields on profile settings page
+- $action: action object being shown
+
+EndProfileFormData: just after showing text entry fields on profile settings page
+- $action: action object being shown
+
+StartProfileSaveForm: before starting to save a profile settings form
+- $action: action object being shown
+
+EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
+- $action: action object being shown
+
+StartEmailFormData: just before showing form input fields on email settings page
+- $action: Action object being shown
+- $scoped: Profile for whom settings are being configured
+
+EndEmailFormData: just after showing form input fields on email settings page
+- $action: action object being shown
+- $scoped: Profile for whom settings are being configured
+
+StartEmailSaveForm: before starting to save a email settings form
+- $action: action object being shown
+- $scoped: Profile user having their email settings saved
+
+EndEmailSaveForm: after saving a email settings form (after commit)
+- $action: action object being shown
+- $scoped: Profile user having their email settings saved
+
+StartRegistrationFormData: just before showing text entry fields on registration page
+- $action: action object being shown
+
+EndRegistrationFormData: just after showing text entry fields on registration page
+- $action: action object being shown
+
+StartRegistrationTry: before validating and saving a new user
+- $action: action object being shown
+
+EndRegistrationTry: after saving a new user (note: no profile or user object!)
+- $action: action object being shown
+
+StartAvatarFormData: before displaying avatar form
+- $action: action object being shown
+
+EndAvatarFormData: after displaying avatar form
+- $action: action object being shown
+
+StartAvatarSaveForm: before saving the avatar
+- $action: action object being shown
+
+EndAvatarSaveForm: after saving the avatar
+- $action: action object being shown
+
+StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
+- $qm: empty queue manager to set
+
+RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
+- $action: action object being shown
+- $user: current user
+
+StartLoadDoc: before loading a help doc (hook this to show your own documentation)
+- $title: title of the document
+- $output: HTML output to show
+
+EndLoadDoc: after loading a help doc (hook this to modify other documentation)
+- $title: title of the document
+- $output: HTML output to show
+
+StartApiRss: after the rss <channel> element is started
+- $action: action object being shown
+
+StartApiAtom: after the <feed> element is started
+- $action: action object being shown
+
+StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
+- $notice: the notice being added
+- &$transports: modifiable list of transports (as strings) to queue for
+
+EndEnqueueNotice: after adding a notice to the queues
+- $notice: the notice being added
+- $transports: modifiable list of transports to use
+
+UnqueueHandleNotice: Handle a notice when no queue manager is available
+- $notice: the notice to handle
+- $queue: the "queue" that is being executed
+
+GetValidDaemons: Just before determining which daemons to run
+- &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
+
+HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
+- &$notice: notice to handle
+
+StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces
+- $action: the current action
+- &$attrs: attributes for the HTML element
+
+EndHtmlElement: Right after outputting the HTML element
+- $action: the current action
+- &$attrs: attributes for the HTML element
+
+StartShowHeadElements: Right after the <head> tag
+- $action: the current action
+
+EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
+- $action: the current action
+
+CheckSchema: chance to check the schema
+
+StartProfileRemoteSubscribe: Before showing the link to remote subscription
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfileRemoteSubscribe: After showing the link to remote subscription
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartGroupSubscribe: Before showing the link to remote subscription
+- $action: the current action
+- $group: the group being shown
+
+EndGroupSubscribe: After showing the link to remote subscription
+- $action: the current action
+- $group: the group being shown
+
+StartProfilePageProfileSection: Starting to show the section of the
+ profile page with the actual profile data;
+ hook to prevent showing the profile (e.g.)
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartProfilePageProfileElements: inside the section, before the first
+ element; prepend elements here
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfilePageProfileElements: inside the section, after the last element;
+ append elements here
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfilePageProfileSection: After showing the section of the profile
+ page with the profile elements
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartProfilePageActionsSection: Starting to show the section of the
+ profile page with action links; hook
+ to hide them (for example)
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartProfilePageActionsElements: inside the list, before the first
+ element; prepend elements here
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfilePageActionsElements: inside the list, after the last element;
+ append elements here
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfilePageActionsSection: After showing the section of the profile
+ page with the entity actions
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartProfilePageAvatar: before showing the avatar on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfilePageAvatar: after showing the avatar on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartProfilePageNickname: before showing the nickname on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfilePageNickname: after showing the nickname on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartProfilePageFullName: before showing the fullname on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfilePageFullName: after showing the fullname on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartProfilePageLocation: before showing the location on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfilePageLocation: after showing the location on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartProfilePageHomepage: before showing the homepage link on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfilePageHomepage: after showing the homepage on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartProfilePageBio: before showing the bio on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfilePageBio: after showing the bio on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartProfilePageProfileTags: before showing the tags on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfilePageProfileTags: after showing the tags on the profile page
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+StartProfileList: when starting a list of profiles (before <ul>)
+- $profilelist: ProfileList widget, with $profile, $action, and $out
+
+EndProfileList: when ending a list of profiles (after </ul>)
+- $profilelist: ProfileList widget
+
+StartProfileListItem: when starting to show a profile list item
+- $item: ProfileListItem widget
+
+EndProfileListItem: after showing a profile list item
+- $item: ProfileListItem widget
+
+StartProfileListItemProfile: the profile data part of the item
+- $item: ProfileListItem widget
+
+EndProfileListItemProfile: the profile data part of the item
+- $item: ProfileListItem widget
+
+StartProfileListItemActions: the actions (buttons) for an item
+- $item: ProfileListItem widget
+
+EndProfileListItemActions: the actions (buttons) for an item
+- $item: ProfileListItem widget
+
+StartProfileListItemProfileElements: inside the <div>
+- $item: ProfileListItem widget
+
+EndProfileListItemProfileElements: inside the <div>
+- $item: ProfileListItem widget
+
+StartProfileListItemAvatar: Showing a profile list avatar
+- $item: ProfileListItem widget
+
+EndProfileListItemAvatar: Showing a profile list avatar
+- $item: ProfileListItem widget
+
+StartProfileListItemFullName: Showing the profile list full name
+- $item: ProfileListItem widget
+
+EndProfileListItemFullName: Showing the profile list full name
+- $item: ProfileListItem widget
+
+StartProfileListItemLocation: Showing the profile list location
+- $item: ProfileListItem widget
+
+EndProfileListItemLocation: Showing the profile list location
+- $item: ProfileListItem widget
+
+StartProfileListItemHomepage: Showing the profile list homepage
+- $item: ProfileListItem widget
+
+EndProfileListItemHomepage: Showing the profile list homepage
+- $item: ProfileListItem widget
+
+StartProfileListItemBio: Showing the profile list bio
+- $item: ProfileListItem widget
+
+EndProfileListItemBio: Showing the profile list bio
+- $item: ProfileListItem widget
+
+StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
+- $item: ProfileListItem widget
+
+EndProfileListItemActionElements: Showing profile list actions (append a button here)
+- $item: ProfileListItem widget
+
+StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
+- $action: the current action
+- &$xrdsoutputter - XRDSOutputter object to write to
+
+EndUserXRDS: End XRDS output (right before the closing XRDS tag)
+- $action: the current action
+- &$xrdsoutputter - XRDSOutputter object to write to
+
+StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
+- $action: the current action
+- &$xrdsoutputter - XRDSOutputter object to write to
+
+EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
+- $action: the current action
+- &$xrdsoutputter - XRDSOutputter object to write to
+
+StartCheckPassword: Check a username/password
+- $nickname: The nickname to check
+- $password: The password to check
+- &$authenticatedUser: set to User object if credentials match a user.
+
+EndCheckPassword: After checking a username/password pair
+- $nickname: The nickname that was checked
+- $password: The password that was checked
+- $authenticatedUser: User object if credentials match a user, else null.
+
+StartChangePassword: Before changing a password
+- Profile $target: The profile of the User that is changing password
+- $oldpassword: the user's old password
+- $newpassword: the desired new password
+
+EndChangePassword: After changing a password
+- Profile $target: The profile of the User that just changed its password
+
+StartHashPassword: Generate a hashed version of the password (like a salted crypt)
+- &$hashed: Hashed version of the password, later put in the database
+- $password: The password that should be hashed
+- $profile: Profile that this password and hash belongs to. Can be null.
+
+StartSetUser: Before setting the currently logged in user
+- $user: user
+
+EndSetUser: After setting the currently logged in user
+- $user: user
+
+StartSetApiUser: Before setting the current API user
+- &$user: user, can be set during event handling (return false to stop processing)
+
+EndSetApiUser: After setting the current API user
+- $user: user, only called if this is an actual user
+
+StartHasRole: Before determing if the a profile has a given role
+- $profile: profile in question
+- $name: name of the role in question
+- &$has_role: does this profile have the named role?
+
+EndHasRole: Before determing if the a profile has a given role
+- $profile: profile in question
+- $name: name of the role in question
+- $has_role: does this profile have the named role?
+
+UserDeleteRelated: Specify additional tables to delete entries from when deleting users
+- $user: User object
+- &$related: array of DB_DataObject class names to delete entries on matching user_id.
+
+GetUrlShorteners: Specify URL shorteners that are available for use
+- &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
+
+StartShortenUrl: About to shorten a URL
+- $url: url to be shortened
+- $shortenerName: name of the requested shortener
+- &$shortenedUrl: short version of the url
+
+EndShortenUrl: After a URL has been shortened
+- $url: url to be shortened
+- $shortenerName: name of the requested shortener
+- $shortenedUrl: short version of the url
+
+StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
+- $action
+- &$src
+- &$theme
+- &$media
+
+EndCssLinkElement: After a <link rel="stylesheet"..> element is written
+- $action
+- $src
+- $theme
+- $media
+
+StartStyleElement: Before a <style...> element is written
+- $action
+- &$code
+- &$type
+- &$media
+
+EndStyleElement: After a <style...> element is written
+- $action
+- $code
+- $type
+- $media
+
+StartScriptElement: Before a <script...> element is written
+- $action
+- &$src
+- &$type
+
+EndScriptElement: After a <script...> element is written
+- $action
+- $src
+- $type
+
+StartInlineScriptElement: Before a <script...> element is written
+- $action
+- &$code
+- &$type
+
+EndInlineScriptElement: After a <script...> element is written
+- $action
+- $code
+- $type
+
+StartLog: Before writing to the logs
+- &$priority
+- &$msg
+- &$filename
+
+EndLog: After writing to the logs
+- $priority
+- $msg
+- $filename
+
+StartBlockProfile: when we're about to block
+- $user: the person doing the block
+- $profile: the person getting blocked, can be remote
+
+EndBlockProfile: when a block has succeeded
+- $user: the person doing the block
+- $profile: the person blocked, can be remote
+
+StartUnblockProfile: when we're about to unblock
+- $user: the person doing the unblock
+- $profile: the person getting unblocked, can be remote
+
+EndUnblockProfile: when an unblock has succeeded
+- $user: the person doing the unblock
+- $profile: the person unblocked, can be remote
+
+StartSubscribe: when a subscription is starting
+- $profile: Profile that is subscribing
+- $other: Profile that is being subscribed to
+
+EndSubscribe: when a subscription is finished
+- $profile: Profile that is subscribing
+- $other: Profile that is being subscribed to
+
+StartUnsubscribe: when an unsubscribe is starting
+- $profile: Profile that is unsubscribing
+- $other: Profile that is being unsubscribed from
+
+EndUnsubscribe: when an unsubscribe is done
+- $profile: Profile that is unsubscribing
+- $other: Profile that is being unsubscribed from
+
+StartJoinGroup: when a user is joining a group
+- $group: the group being joined
+- $profile: the local or remote user joining
+
+EndJoinGroup: when a user finishes joining a group
+- $group: the group being joined
+- $profile: the local or remote user joining
+
+StartLeaveGroup: when a user is leaving a group
+- $group: the group being left
+- $profile: the local or remote user leaving
+
+EndLeaveGroup: when a user has left a group
+- $group: the group being left
+- $profile: the local or remote user leaving
+
+StartShowContentLicense: Showing the default license for content
+- $action: the current action
+
+EndShowContentLicense: Showing the default license for content
+- $action: the current action
+
+GetImTransports: Get IM transports that are available
+- &$transports: append your transport to this array like so: $transports[transportName]=array('display'=>display)
+
+NormalizeImScreenname: Normalize an IM screenname
+- $transport: transport the screenname is on
+- &$screenname: screenname to be normalized
+
+ValidateImScreenname: Validate an IM screenname
+- $transport: transport the screenname is on
+- $screenname: screenname to be validated
+- $valid: is the screenname valid?
+
+SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname
+- $transport: transport the screenname exists on
+- $screenname: screenname being confirmed
+- $code: confirmation code for confirmation URL
+- $user: user requesting the confirmation
+
+StartUserRegister: When a new user is being registered
+- $profile: Profile object with new profile data (no ID yet)
+
+EndUserRegister: When a new user has been registered
+- $profile: Profile object with new profile data
+
+StartRobotsTxt: Before outputting the robots.txt page
+- &$action: RobotstxtAction being shown
+
+EndRobotsTxt: After the default robots.txt page (good place for customization)
+- &$action: RobotstxtAction being shown
+
+StartGetProfileUri: When determining the canonical URI for a given profile
+- $profile: the current profile
+- &$uri: the URI
+
+EndGetProfileUri: After determining the canonical URI for a given profile
+- $profile: the current profile
+- &$uri: the URI
+
+StartGetProfileAcctUri: Get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
+- $profile: Profile of user we want to get acct: URI for
+- &$acct: string with the resulting acct: uri
+
+EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
+- $profile: Profile of user we want to get acct: URI for
+- &$acct: string with the resulting acct: uri
+
+StartFindMentions: start finding mentions in a block of text
+- $sender: sender profile
+- $text: plain text version of the notice
+- &$mentions: mentions found so far. Array of arrays; each array
+ has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
+ 'title' (title of the link), 'position' (position of the text to
+ replace), 'text' (text to replace)
+
+EndFindMentions: end finding mentions in a block of text
+- $sender: sender profile
+- $text: plain text version of the notice
+- &$mentions: mentions found so far. Array of arrays; each array
+ has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
+ 'title' (title of the link), 'position' (position of the text to
+ replace), 'text' (text to replace)
+
+StartShowSubscriptionsContent: before showing the subscriptions content
+- $action: the current action
+
+EndShowSubscriptionsContent: after showing the subscriptions content
+- $action: the current action
+
+StartShowUserGroupsContent: before showing the user groups content
+- $action: the current action
+
+EndShowUserGroupsContent: after showing the user groups content
+- $action: the current action
+
+StartShowAllContent: before showing the all (you and friends) content
+- $action: the current action
+
+EndShowAllContent: after showing the all (you and friends) content
+- $action: the current action
+
+StartShowSubscriptionsMiniList: at the start of subscriptions mini list
+- $action: the current action
+
+EndShowSubscriptionsMiniList: at the end of subscriptions mini list
+- $action: the current action
+
+StartShowGroupsMiniList: at the start of groups mini list
+- $action: the current action
+
+EndShowGroupsMiniList: at the end of groups mini list
+- $action: the current action
+
+StartDeleteUserForm: starting the data in the form for deleting a user
+- $action: action being shown
+- $user: user being deleted
+
+EndDeleteUserForm: Ending the data in the form for deleting a user
+- $action: action being shown
+- $user: user being deleted
+
+StartDeleteUser: handling the post for deleting a user
+- $action: action being shown
+- $user: user being deleted
+
+EndDeleteUser: handling the post for deleting a user
+- $action: action being shown
+- $user: user being deleted
+
+StartNoticeAsActivity: before converting a notice to an activity
+- $notice: notice being converted
+- &$activity: initially empty activity
+
+EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)
+- $notice: notice being converted
+- &$activity: activity, now more-or-less full
+
+StartNoticeSaveWeb: before saving a notice through the Web interface
+- $action: action being executed (instance of NewNoticeAction)
+- &$authorId: integer ID of the author
+- &$text: text of the notice
+- &$options: additional options (location, replies, etc.)
+
+EndNoticeSaveWeb: after saving a notice through the Web interface
+- $action: action being executed (instance of NewNoticeAction)
+- $notice: notice that was saved
+
+StartRssEntryArray: at the start of copying a notice to an array
+- $notice: the notice being copied
+- &$entry: the entry (empty at beginning)
+
+EndRssEntryArray: at the end of copying a notice to an array
+- $notice: the notice being copied
+- &$entry: the entry, with all the fields filled up
+
+NoticeDeleteRelated: at the beginning of deleting related fields to a notice
+- $notice: notice being deleted
+
+FileDeleteRelated: at the beginning of deleting related fields to a File
+- $notice: File being deleted
+
+StartShowHeadTitle: when beginning to show the <title> element
+- $action: action being shown
+
+EndShowHeadTitle: when done showing the <title>
+- $action: action being shown
+
+StartShowPageTitle: when beginning to show the page title <h1>
+- $action: action being shown
+
+EndShowPageTitle: when done showing the page title <h1>
+- $action: action being shown
+
+StartDeleteOwnNotice: when a user starts to delete their own notice
+- $user: the user doing the delete
+- $notice: the notice being deleted
+
+EndDeleteOwnNotice: when a user has deleted their own notice
+- $user: the user doing the delete
+- $notice: the notice being deleted
+
+StartShowFeedLinkList: before showing the feed list in the sidebar
+- $action: action being executed
+- $feeds: list of feeds to show
+
+EndShowFeedLinkList: after showing the feed list in the sidebar
+- $action: action being executed
+- $feeds: list of feeds shown
+
+StartShowFeedLink: before showing an individual feed item
+- $action: action being executed
+- $feed: feed to show
+
+EndShowFeedLink: after showing an individual feed
+- $action: action being executed
+- $feed: feed to show
+
+StartShowNoticeForm: before showing the notice form (before <form>)
+- $action: action being executed
+
+EndShowNoticeForm: after showing the notice form (after <form>)
+- $action: action being executed
+
+StartShowEntryForms: microapp entry form tab data
+- &$tabs: tab assoc array with 'tag' => (title, href to create new entry)
+
+StartGrantRole: when a role is being assigned
+- $profile: profile that will have the role
+- $role: string name of the role
+
+EndGrantRole: when a role has been successfully assigned
+- $profile: profile that will have the role
+- $role: string name of the role
+
+StartRevokeRole: when a role is being revoked
+- $profile: profile that will lose the role
+- $role: string name of the role
+
+EndRevokeRole: when a role has been revoked
+- $profile: profile that lost the role
+- $role: string name of the role
+
+StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
+- &$activity: received activity
+- $profile: profile of the user publishing the entry
+- &$notice: notice created; initially null, can be set
+
+EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
+- $activity: received activity
+- $profile: profile of the user publishing the entry
+- $notice: notice that was created
+
+AdminPanelCheck: When checking whether the current user can access a given admin panel
+- $name: Name of the admin panel
+- &$isOK: Boolean whether the user is allowed to use the panel
+
+StartAdminPanelNav: Before displaying the first item in the list of admin panels
+- $nav The AdminPanelNav widget
+
+EndAdminPanelNav: After displaying the last item in the list of admin panels
+- $nav The AdminPanelNav widget
+
+StartActivityObjectFromNotice: When converting a notice to an activity:object
+- $notice: The notice being converted
+- &$object: The resulting object. Fill this and return false to override defaults.
+
+EndActivityObjectFromNotice: After converting a notice to an activity:object
+- $notice: The notice being converted
+- &$object: The resulting object. Can be edited
+
+StartActivityObjectFromProfile: When converting a profile to an activity:object
+- $profile: The profile being converted
+- &$object: The (empty) object. Fill it up and return false to override defaults.
+
+EndActivityObjectFromProfile: After converting a profile to an activity:object
+- $profile: The profile being converted
+- &$object: The finished object. Can be tweaked
+
+StartActivityObjectFromGroup: When converting a group to an activity:object
+- $group: The group being converted
+- &$object: The (empty) object. Fill and return false to override.
+
+EndActivityObjectFromGroup: After converting a group to an activity:object
+- $group: The group being converted
+- &$object: The finished object. Tweak as needed.
+
+StartImportActivity: when we start to import an activity
+- $user: User to make the author import
+- $author: Author of the feed; good for comparisons
+- $activity: The current activity
+- $trusted: How "trusted" the process is
+- &$done: Return value; whether to continue
+
+EndImportActivity: when we finish importing an activity
+- $user: User to make the author import
+- $author: Author of the feed; good for comparisons
+- $activity: The current activity
+- $trusted: How "trusted" the process is
+
+StartProfileSettingsActions: when we're showing account-management action list
+- $action: Action being shown (use for output)
+
+EndProfileSettingsActions: when we're showing account-management action list
+- $action: Action being shown (use for output)
+
+StartOpenNoticeListItemElement: Before the opening <li> of a notice list element
+- $nli: The notice list item being shown
+
+EndOpenNoticeListItemElement: After the opening <li> of a notice list element
+- $nli: The notice list item being shown
+
+StartCloseNoticeListItemElement: Before the closing </li> of a notice list element
+- $nli: The notice list item being shown
+
+EndCloseNoticeListItemElement: After the closing </li> of a notice list element
+- $nli: The notice list item being shown
+
+StartGroupEditFormData: Beginning the group edit form entries
+- $form: The form widget being shown
+
+EndGroupEditFormData: Ending the group edit form entries
+- $form: The form widget being shown
+
+StartGroupSave: After initializing but before saving a group
+- &$group: group about to be saved
+
+EndGroupSave: After saving a group, aliases, and first member
+- $group: group that was saved
+
+StartInterpretCommand: Before running a command
+- $cmd: First word in the string, 'foo' in 'foo argument'
+- $arg: Argument, if any, like 'argument' in 'foo argument'
+- $user: User who issued the command
+- &$result: Resulting command; you can set this!
+
+EndInterpretCommand: Before running a command
+- $cmd: First word in the string, 'foo' in 'foo argument'
+- $arg: Argument, if any, like 'argument' in 'foo argument'
+- $user: User who issued the command
+- $result: Resulting command
+
+StartGroupActionsList: Start the list of actions on a group profile page (after <ul>, before first <li>)
+- $action: action being executed (for output and params)
+- $group: group for the page
+
+EndGroupActionsList: End the list of actions on a group profile page (before </ul>, after last </li>)
+- $action: action being executed (for output and params)
+- $group: group for the page
+
+StartGroupProfileElements: Start showing stuff about the group on its profile page
+- $action: action being executed (for output and params)
+- $group: group for the page
+
+EndGroupProfileElements: Start showing stuff about the group on its profile page
+- $action: action being executed (for output and params)
+- $group: group for the page
+
+StartShowProfileTagContent: When showing a people tag page
+- $action: action being executed (for output and params)
+
+EndShowProfileTagContent: After showing the contents of a people tag page
+- $action: action being executed (for output and params)
+
+StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles
+- $action: action being executed (for output and params)
+
+EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles
+- $action: action being executed (for output and params)
+
+StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers
+- $action: action being executed (for output and params)
+
+EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers
+- $action: action being executed (for output and params)
+
+StartTagProfileAction: When starting to show profile tagging page
+- $action: action being executed (for output and params)
+- $profile: profile being tagged
+
+EndTagProfileAction: After showing profile tagging page
+- $action: action being executed (for output and params)
+- $profile: profile being tagged
+
+StartProfileCompletionSearch: When starting a profile search for autocompletion
+- $action: action being executed (for output and params)
+- &$profile: result Profile objects
+- $search_engine: the search engine
+
+EndProfileCompletionSearch: After search results for profile autocompletion have been found
+- $action: profilec completion action
+- &$profile: current result Profile objects
+- $search_engine: The search engine object
+
+StartShowTagProfileForm: When showing people tagging form
+- $action: action being executed (for output and params)
+- $profile: profile being tagged
+
+EndShowTagProfileForm: After showing people tagging form
+- $action: action being executed (for output and params)
+- $profile: profile being tagged
+
+StartSavePeopletags: When starting to save people tags
+- $action: action being executed (for output and params)
+- $tagstring: string input, a list of tags
+
+EndSavePeopletags: After saving people tags
+- $action: action being executed (for output and params)
+- $tagstring: string input, a list of tags
+
+StartProfiletagGetUri: when generating the Uri for a people tag
+- $profile_list: the people tag, a Profile_list object
+- &$uri: the URI
+
+EndProfiletagGetUri: after generating the uri for a people tag
+- $profile_list: the people tag, a Profile_list object
+- &$uri: the URI
+
+StartUserPeopletagHomeUrl: when generating the homepage url for a people tag
+- $profile_list: the people tag, a Profile_list object
+- &$url: the URL
+
+EndUserPeopletagHomeUrl: after generating the homepage url for a people tag
+- $profile_list: the people tag, a Profile_list object
+- &$url: the URL
+
+StartProfiletagPermalink: when generating the permalink url for a people tag
+- $profile_list: the people tag, a Profile_list object
+- &$url: the URL
+
+EndProfiletagPermalink: after generating the permalink url for a people tag
+- $profile_list: the people tag, a Profile_list object
+- &$url: the URL
+
+StartTagProfile: when tagging a profile
+- $tagger: profile tagging
+- $tagged: profile being tagged
+- $tag: the tag
+
+EndTagProfile: after tagging a profile
+- $newtag: the newly created Profile_tag object
+
+StartUntagProfile: when deleting a people tag
+- $ptag: the Profile_tag object being deleted
+
+EndUntagProfile: after deleting a people tag
+- $orig: a copy of the deleted Profile_tag object
+
+StartSubscribePeopletag: when subscribing to a people tag
+- $peopletag: Profile_list object being subscribed to
+- $profile: subscriber's profile
+
+EndSubscribePeopletag: after subscribing to a people tag
+- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
+- $profile: subscriber's profile
+
+StartUnsubscribePeopletag: when unsubscribing to a people tag
+- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
+- $profile: subscriber's profile
+
+EndUnsubscribePeopletag: after unsubscribing to a people tag
+- $peopletag: Profile_list object being subscribed to
+- $profile: subscriber's profile
+
+StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag
+- $profile_list: the people tag, a Profile_list object
+- &$object: activity object
+
+EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag
+- $profile_list: the people tag, a Profile_list object
+- &$object: activity object
+
+StartPeopletagGroupNav: Showing the people tag nav menu
+- $menu: the menu widget; use $menu->action for output
+
+EndPeopletagGroupNav: after showing the people tag nav menu
+- $menu: the menu widget; use $menu->action for output
+
+StartShowPeopletagItem: when showing a people tag
+- $widget: PeopletagListItem widget
+
+EndShowPeopletagItem: after showing a people tag
+- $widget: PeopletagListItem widget
+
+StartSubscribePeopletagForm: when showing people tag subscription form
+- $action: action being executed (for output and params)
+- $peopletag: people tag being subscribed to
+
+EndSubscribePeopletagForm: after showing the people tag subscription form
+- $action: action being executed (for output and params)
+- $peopletag: people tag being subscribed to
+
+StartShowPeopletags: when showing a textual list of people tags
+- $widget: PeopletagsWidget; use $widget->out for output
+- $tagger: profile of the tagger
+- $tagged: profile tagged
+
+EndShowPeopletags: after showing a textual list of people tags
+- $widget: PeopletagsWidget; use $widget->out for output
+- $tagger: profile of the tagger
+- $tagged: profile tagged
+
+StartProfileListItemTags: when showing people tags in a profile list item widget
+- $widget: ProfileListItem widget
+
+EndProfileListItemTags: after showing people tags in a profile list item widget
+- $widget: ProfileListItem widget
+
+StartActivityObjectOutputAtom: Called at start of Atom XML output generation for ActivityObject chunks, just inside the <activity:object>. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
+- $obj: ActivityObject
+- $out: XMLOutputter to append custom output
+
+EndActivityObjectOutputAtom: Called at end of Atom XML output generation for ActivityObject chunks, just inside the </activity:object>
+- $obj: ActivityObject
+- $out: XMLOutputter to append custom output
+
+StartActivityObjectOutputJson: Called at start of JSON output generation for ActivityObject chunks: the array has not yet been filled out. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
+- $obj ActivityObject
+- &$out: array to be serialized; you're free to modify it
+
+EndActivityObjectOutputJson: Called at end of JSON output generation for ActivityObject chunks: the array has not yet been filled out.
+- $obj ActivityObject
+- &$out: array to be serialized; you're free to modify it
+
+StartNoticeWhoGets: Called at start of inbox delivery prep; plugins can schedule notices to go to particular profiles that would otherwise not have reached them. Canceling will take over the entire addressing operation. Be aware that output can be cached or used several times, so should remain idempotent.
+- $notice Notice
+- &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
+
+EndNoticeWhoGets: Called at end of inbox delivery prep; plugins can filter out profiles from receiving inbox delivery here. Be aware that output can be cached or used several times, so should remain idempotent.
+- $notice Notice
+- &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
+
+StartDefaultLocalNav: When showing the default local nav
+- $menu: the menu
+- $user: current user
+
+EndDefaultLocalNav: When showing the default local nav
+- $menu: the menu
+- $user: current user
+
+StartShowAccountProfileBlock: When showing the profile block for an account
+- $out: XMLOutputter to append custom output
+- $profile: the profile being shown
+
+EndShowAccountProfileBlock: After showing the profile block for an account
+- $out: XMLOutputter to append custom output
+- $profile: the profile being shown
+
+StartShowGroupProfileBlock: When showing the profile block for a group
+- $out: XMLOutputter to append custom output
+- $profile: the profile being shown
+
+EndShowGroupProfileBlock: After showing the profile block for a group
+- $out: XMLOutputter to append custom output
+- $group: the group being shown
+
+StartShowConversation: start the listing of a conversation
+- $action: Action object (used mainly as HTMLOutputter)
+- $conv: Conversation object, has functions to retrieve relevant notices
+- $scoped: Profile for scoping (null if not logged in)
+
+EndShowConversation: after the listing of a conversation
+- $action: Action object (used mainly as HTMLOutputter)
+- $conv: Conversation object, has functions to retrieve relevant notices
+- $scoped: Profile for scoping (null if not logged in)
+
+StartShowThreadedNoticeTail: when showing the replies etc. to a notice
+- $nli: parent noticelistitem
+- $notice: parent notice
+- &$children: list of children
+
+EndShowThreadedNoticeTail: when showing the replies etc. to a notice
+- $nli: parent noticelistitem
+- $notice: parent notice
+- $children: list of children
+
+StartShowThreadedNoticeSub: when showing a reply to a notice
+- $nli: parent noticelistitem
+- $parent: parent notice
+- $child: child notice
+
+EndShowThreadedNoticeSub: when showing a reply to a notice
+- $nli: parent noticelistitem
+- $parent: parent notice
+- $child: child notice
+
+StartAddEmailAddress: when adding an email address through the Web UI
+- $user: user getting the new address
+- $email: email being added
+
+EndAddEmailAddress: done adding an email address through the Web UI
+- $user: user getting the new address
+- $email: email being added
+
+StartValidateEmailInvite: when validating an email address for invitations
+- $user: user doing the invite
+- $email: email address
+- &$valid: flag for if it's valid; can be modified
+
+EndValidateEmailInvite: after validating an email address for invitations
+- $user: user doing the invite
+- $email: email address
+- &$valid: flag for if it's valid; can be modified
+
+StartLocalURL: before resolving a local url for an action
+- &$action: action to find a path for
+- &$paramsi: parameters to pass to the action
+- &$fragment: any url fragement
+- &$addSession: whether to add session variable
+- &$url: resulting URL to local resource
+
+EndLocalURL: before resolving a local url for an action
+- &$action: action to find a path for
+- &$paramsi: parameters to pass to the action
+- &$fragment: any url fragement
+- &$addSession: whether to add session variable
+- &$url: resulting URL to local resource
+
+StartProfileGetAvatar: When getting an avatar for a profile
+- $profile: profile
+- $size: size of the avatar
+- &$avatar: avatar
+
+EndProfileGetAvatar: After getting an avatar for a profile
+- $profile: profile
+- $size: size of the avatar
+- &$avatar: avatar
+
+StartRegisterSuccess: Before showing the registration success message
+- $action: the registration action
+
+StartRegisterSuccess: After showing the registration success message
+- $action: the registration action
+
+StartDocFileForTitle: Before searching for a doc or mail template
+- $title: Title we're looking for
+- &$paths: Paths we're searching
+- &$filename: Filename so far (set this if you want)
+
+EndDocFileForTitle: After searching for a doc or mail template
+- $title: Title we looked for
+- $paths: Paths we searched
+- &$filename: Filename so far (set this if you want)
+
+StartReadWriteTables: when noting which tables must be read-write, even on read-only actions
+- &$tables: list of table names
+- &$rwdb: read-write database URI
+
+EndReadWriteTables: after noting which tables must be read-write, even on read-only actions
+- $tables: list of table names
+- $rwdb: read-write database URI
+
+StartShowInviteForm: Right before displaying the invitations form
+- $action: invitation action
+
+EndShowInviteForm: After displaying the invitations form
+- $action: invitation action
+
+StartSendInvitations: Right before sending invitations
+- $action: invitation action
+
+EndSendInvitations: Right after sending invitations
+- $action: invitation action
+
+StartShowInvitationSuccess: Right before showing invitations success msg
+- $action: invitation action
+
+EndShowInvitationSuccess: After showing invitations success msg
+- $action: invitation action
+
+StartUpgrade: when starting a site upgrade
+
+EndUpgrade: when ending a site upgrade; good place to do your own upgrades
+
+HaveIMPlugin: is there an IM plugin loaded?
+- &$haveIMPlugin: set me to true if you're loaded!
+
+StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div
+- $nli: NoticeListItem being shown
+
+EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div
+- $nli: NoticeListItem being shown
+
+StartNoticeInScope: Before checking if a notice should be visible to a user
+- $notice: The notice to check
+- $profile: The profile to check for scope
+- &$bResult: The boolean result; fill this in if you want to skip
+
+EndNoticeInScope: After checking if a notice should be visible to a user
+- $notice: The notice to check
+- $profile: The profile to check for scope
+- &$bResult: The boolean result; overwrite this if you so desire
+
+StartNoticeListPrefill: Before pre-filling a list of notices with extra data
+- &$notices: Notices to be pre-filled
+- $avatarSize: The avatar size for the list
+
+EndNoticeListPrefill: After pre-filling a list of notices with extra data
+- &$notices: Notices that were pre-filled
+- &$profiles: Profiles that were pre-filled
+- $avatarSize: The avatar size for the list
+
+OtherAccountProfiles: Hook to add account profiles to a user account profile block
+- $profile: the Profile being shown
+- &$others: Modifiable array of profile info arrays. Each one has the following fields:
+ href: link to the profile
+ text: text for the profile
+ image: mini image for the profile
+
+CreateFileImageThumbnailSource: Hook to create image thumbnail source from a File
+- $file: 'File' object to source the image from
+- &$imgPath: Path to image file which can be used as source for our thumbnail algorithm.
+- $media: MIME media type ('image', 'video', 'audio' etc.)
+
+StartResizeImageFile: Hook to resize an image and output it to a file. No matching End event yet.
+- $imagefile: ImageFile object we're resizing.
+- $outpath: string with output filepath
+- $box: array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h').
+
+FillImageFileMetadata: Get more metadata about the ImageFile if it is perhaps not a real local file
+- $imagefile ImageFile object which we're getting metadata for (such as animated status, width/height etc.)
+
+StartShowAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
+- $out: HTMLOutputter class to use for outputting HTML.
+- $file: 'File' object which we're going to show representation for.
+
+EndShowAttachmentRepresentation: Executed after Attachment representation, despite perhaps being unsupported media.
+- $out: HTMLOutputter class to use for outputting HTML.
+- $file: 'File' object which we're going to show representation for.
+
+ShowUnsupportedAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
+- $out: HTMLOutputter class to use for outputting HTML.
+- $file: 'File' object which we're going to show representation for.
+
+StartNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
+- $stored: Notice object that is being distributed.
+- &$mentioned_ids: Array of profile IDs (not just for local users) who got mentioned by the notice.
+
+EndNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
+- $stored: Notice object that is being distributed.
+- $mentioned_ids: Array of profile IDs (not just for local users) who got mentioned by the notice.
+
+StartHomeStubNavItems: Go back Home nav items. Default includes just one item 'home'
+- $out: HTMLOutputter used to output (usually an Action, but not always!)
+- &$items: Referenced array of items in the nav (add if desired)
+
+EndHomeStubNavItems:
+- $out: HTMLOutputter used to output (usually an Action, but not always!)
+- $items: array of menu items
+
+StartSubMenu: Before outputting a submenu (including enclosing tags) to HTML
+- $out: HTMLOutputter used to output (usually an Action, but not always!)
+- $menu: The Menu object outputted as a submenu.
+- $label: Localized text which represents the menu item.
+
+EndSubMenu: After outputting a submenu (including enclosing tags) to HTML
+- $out: HTMLOutputter used to output (usually an Action, but not always!)
+- $menu: The Menu object outputted as a submenu.
+- $label: Localized text which represents the menu item.
+
+StartDocNav: Before outputting the docs Nav
+- $nav: The DoclNav widget
+
+EndDocNav: After outputting the docs Nav
+- $nav: The DoclNav widget
--- /dev/null
+Plugin Development
+=======================
+
+SamplePlugin.php
+-----------------------
+
+Each plugin requires a main class to interact with the GNU social system.
+
+The main class usually extends the Plugin class that comes with GNU social.
+
+The class has standard-named methods that will be called when certain events
+happen in the code base. These methods have names like 'onX' where X is an
+event name (see EVENTS.txt for the list of available events). Event handlers
+have pre-defined arguments, based on which event they're handling. A typical
+event handler:
+
+```php
+function onSomeEvent($paramA, &$paramB)
+{
+ if ($paramA == 'jed') {
+ throw new Exception(sprintf(_m("Invalid parameter %s"), $paramA));
+ }
+ $paramB = 'spock';
+ return true;
+}
+```
+
+Event Handlers
+-----------------------
+
+Event handlers must return a Boolean value.
+
+If they return false, all other event handlers for this event (in other plug-in)
+will be skipped, and in some cases the default processing for that event would
+be skipped. This is great for replacing the default action of an event.
+
+If the handler returns true, processing of other event handlers and the default
+processing will continue. This is great for extending existing functionality.
+
+If the handler throws an exception, processing will stop, and the exception's
+error will be shown to the user.
+
+Installation
+------------------
+
+To install a plugin (like this one), site admins add the following code to their
+config.php file:
+
+```php
+addPlugin('Sample');
+```
+
+Plugins must be installed in one of the following directories:
+
+* local/plugins/{$pluginclass}.php
+* local/plugins/{$name}/{$pluginclass}.php
+* local/{$pluginclass}.php
+* local/{$name}/{$pluginclass}.php
+* plugins/{$pluginclass}.php
+* plugins/{$name}/{$pluginclass}.php
+
+Here, `{$name}` is the name of the plugin, like 'Sample', and `{$pluginclass}`
+is the name of the main class, like 'SamplePlugin'. Plugins that are part of
+the main GNU social distribution go in 'plugins' and third-party or local ones
+go in 'local'.
+
+Simple plugins can be implemented as a single module. Others are more complex
+and require additional modules; these should use their own directory, like
+'local/plugins/{$name}/'. All files related to the plugin, including images,
+JavaScript, CSS, external libraries or PHP modules should go in the plugin
+directory.
+
+Plugin Configuration
+------------------
+
+Plugins are configured using public instance attributes. To set their values,
+site administrators use this syntax:
+
+```php
+addPlugin('Sample', ('attr1' => 'foo', 'attr2' => 'bar'));
+```
+
+The same plugin class can be initialized multiple times with different arguments:
+
+```php
+addPlugin('EmailNotify', array('sendTo' => 'evan@status.net'));
+addPlugin('EmailNotify', array('sendTo' => 'brionv@status.net'));
+```
+
+```php
+class SamplePlugin extends Plugin
+{
+ public $attr1 = null;
+ public $attr2 = null;
+}
+```
+
+Initialization
+------------------
+
+Plugins overload this method to do any initialization they need, like connecting
+to remote servers or creating paths or so on. @return boolean hook value; true
+means continue processing, false means stop.
+
+```php
+function initialize()
+{
+ return true;
+}
+```
+
+Clean Up
+------------------
+
+Plugins overload this method to do any cleanup they need, like disconnecting from
+remote servers or deleting temp files or so on.
+
+```php
+function cleanup()
+{
+ return true;
+}
+```
+
+Database schema setup
+------------------
+
+Plugins can add their own tables to the GNU social database. Plugins should use
+GNU social's schema interface to add or delete tables. The ensureTable() method
+provides an easy way to ensure a table's structure and availability.
+
+By default, the schema is checked every time GNU social is run (say, when a Web
+page is hit). Admins can configure their systems to only check the schema when
+the checkschema.php script is run, greatly improving performance. However, they
+need to remember to run that script after installing or upgrading a plugin!
+
+```php
+function onCheckSchema()
+{
+ $schema = Schema::get();
+
+ // '''For storing user-submitted flags on profiles'''
+
+ $schema->ensureTable('user_greeting_count',
+ array(new ColumnDef('user_id', 'integer', null,
+ true, 'PRI'),
+ new ColumnDef('greeting_count', 'integer')));
+
+ return true;
+}
+```
+
+Load related modules when needed
+------------------
+
+Most non-trivial plugins will require extra modules to do their work. Typically
+these include data classes, action classes, widget classes, or external libraries.
+
+This method receives a class name and loads the PHP file related to that class.
+By tradition, action classes typically have files named for the action, all
+lower-case. Data classes are in files with the data class name, initial letter
+capitalized.
+
+Note that this method will be called for *all* overloaded classes, not just ones
+in this plugin! So, make sure to return true by default to let other plugins,
+and the core code, get a chance.
+
+```php
+function onAutoload($cls)
+{
+ $dir = dirname(__FILE__);
+
+ switch ($cls)
+ {
+ case 'HelloAction':
+ include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
+ return false;
+ case 'User_greeting_count':
+ include_once $dir . '/'.$cls.'.php';
+ return false;
+ default:
+ return true;
+ }
+}
+```
+
+Map URLs to actions
+------------------
+
+This event handler lets the plugin map URLs on the site to actions (and thus an
+action handler class). Note that the action handler class for an action will be
+named 'FoobarAction', where action = 'foobar'. The class must be loaded in the
+onAutoload() method.
+
+```php
+function onRouterInitialized($m)
+{
+ $m->connect('main/hello',
+ array('action' => 'hello'));
+ return true;
+}
+```
+
+Modify the default menu to link to our custom action
+------------------
+
+Using event handlers, it's possible to modify the default UI for pages almost
+without limit. In this method, we add a menu item to the default primary menu
+for the interface to link to our action.
+
+Action Class
+------------------
+
+The Action class provides a rich set of events to hook, as well as output methods.
+
+```php
+function onEndPrimaryNav($action)
+{
+ // '''common_local_url()''' gets the correct URL for the action name we provide
+
+ $action->menuItem(common_local_url('hello'),
+ _m('Hello'), _m('A warm greeting'), false, 'nav_hello');
+ return true;
+}
+
+function onPluginVersion(&$versions)
+{
+ $versions[] = array('name' => 'Sample',
+ 'version' => STATUSNET_VERSION,
+ 'author' => 'Brion Vibber, Evan Prodromou',
+ 'homepage' => 'http://example.org/plugin',
+ 'rawdescription' =>
+ _m('A sample plugin to show basics of development for new hackers.'));
+ return true;
+}
+```
+
+hello.php
+------------------
+
+This section is taken directly from the 'hello.php'. ( plugins/Sample/hello.php )
+
+Give a warm greeting to our friendly user.
+
+This sample action shows some basic ways of doing output in an action class.
+
+Action classes have several output methods that they override from the parent class.
+
+```php
+class HelloAction extends Action
+{
+ var $user = null;
+ var $gc = null;
+}
+```
+
+Take arguments for running
+------------------
+
+This method is called first, and it lets the action class get all its arguments
+and validate them. It's also the time to fetch any relevant data from the database.
+
+Action classes should run parent::prepare(array $args = []) as the first line
+of this method to make sure the default argument-processing happens.
+
+```php
+function prepare(array $args = [])
+{
+ parent::prepare($args);
+
+ $this->user = common_current_user();
+
+ if (!empty($this->user)) {
+ $this->gc = User_greeting_count::inc($this->user->id);
+ }
+
+ return true;
+}
+```
+
+Handle request
+------------------
+
+This is the main method for handling a request. Note that most preparation
+should be done in the prepare() method; by the time handle() is called the
+action should be more or less ready to go.
+
+```php
+function handle()
+{
+ parent::handle();
+
+ $this->showPage();
+}
+```
+
+Title of this page
+------------------
+
+Override this method to show a custom title.
+
+```php
+function title()
+{
+ if (empty($this->user)) {
+ return _m('Hello');
+ } else {
+ return sprintf(_m('Hello, %s'), $this->user->nickname);
+ }
+}
+```
+
+Show content in the content area
+------------------
+
+The default GNU social page has a lot of decorations: menus, logos, tabs, all
+that jazz. This method is used to show content in the content area of the
+page; it's the main thing you want to overload. This method also demonstrates
+use of a plural localized string.
+
+```php
+function showContent()
+{
+ if (empty($this->user)) {
+ $this->element('p', array('class' => 'greeting'),
+ _m('Hello, stranger!'));
+ } else {
+ $this->element('p', array('class' => 'greeting'),
+ sprintf(_m('Hello, %s'), $this->user->nickname));
+ $this->element('p', array('class' => 'greeting_count'),
+ sprintf(_m('I have greeted you %d time.',
+ 'I have greeted you %d times.',
+ $this->gc->greeting_count),
+ $this->gc->greeting_count));
+ }
+}
+```
+
+Return true if read only.
+------------------
+
+Some actions only read from the database; others read and write. The simple
+database load-balancer built into GNU social will direct read-only actions to
+database mirrors (if they are configured) and read-write actions to the master database.
+
+This defaults to false to avoid data integrity issues, but you should make sure
+to overload it for performance gains.
+
+```php
+function isReadOnly($args)
+{
+ return false;
+}
+```
+
--- /dev/null
+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/<servername>.php - for a virtual host
+* /etc/statusnet/<servername>_<pathname>.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'.
+sslproxy: Whether to force GNUsocial to think it is HTTPS when the
+ server gives no such information. I.e. when you're using a reverse
+ proxy that adds the encryption layer but the webserver that runs PHP
+ isn't configured with a key and certificate.
+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
+<http://pear.php.net/manual/en/package.database.db-dataobject.intro-configuration.php>).
+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.
+daemon: Wather to use queuedaemon. Defaults to false, which means
+ you'll use OpportunisticQM plugin.
+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 <group>/<queue> or <group>/<queue>/<site>,
+ 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 <https://www.w3.org/Protocols/rfc2616/rfc2616-sec8.html#sec8.1.4>,
+ 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. 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.
+
+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 false.
+restore: whether users can restore their profiles from backup files. Defaults
+ to false.
+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.
+
+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).
+
+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).
+
+process_links: follow redirects and save all available file information
+ (mimetype, date, size, oembed, etc.). Defaults to true.
+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.
+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.
+show_thumbs: show thumbnails in notice lists for uploaded images, and photos
+ and videos linked remotely that provide oEmbed info. Defaults to true.
+show_html: show (filtered) text/html attachments (and oEmbed HTML etc.).
+ Doesn't affect AJAX calls. Defaults to false.
+filename_base: for new files, choose one: 'upload', 'hash'. Defaults to hash.
+
+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.
+
+search
+------
+
+Some stuff for search.
+
+type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
+ be 'fulltext' or 'like' (default). 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 cache layers 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.
+
+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).
+
+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 <https://en.wikipedia.org/wiki/Robots_exclusion_standard#Crawl-delay_directive>
+ 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
+---
+
+These are some options for fine-tuning how and when the server will
+shorten URLs.
+
+shortener: URL shortening service to use by default. Users can override
+ individually. 'internal' by default.
+maxurllength: 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 100. 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 cache layers. 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 developing..
+
+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 <http://curl.haxx.se/> 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.
+
+performance
+-----------
+
+high: if you need high performance, or if you're seeing bad
+ performance, set this to true. It will turn off some high-intensity code from
+ the site.
+
+cache
+-----
+
+dir: A string path to a writable directory that will be used as temporary cache
+ for some functions (currently just the HtmlSanitizer).
+ If it is not set, the GNU social installation directory will be used.
+
+oldschool
+---------
+
+enabled: enable certain old-style user settings options, like stream-only mode,
+ conversation trees, and nicknames in streams. Off by default, and
+ may not be well supported in future versions.
--- /dev/null
+Plugins
+=======
+
+GNU social supports 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 AddMyWebsiteLink($action)
+{
+$action->menuItem('http://mywebsite.net/', _('My web site'), _('Example web link'));
+return true;
+}
+
+Event::addHandler('EndPrimaryNav', 'AddMyWebsiteLink');
+
+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 GNU social) 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.
--- /dev/null
+Initial simple way to Webfinger enable your domain -- needs PHP.
+================================================================
+
+This guide needs some updating, since it will only guide you to present
+XML data (while the curl command likely gives you JSON). The workaround
+is to simply make curl get 'webfinger.xml' instead, and/or have another
+file that contains JSON, but that requires editing the PHP file as well.
+
+Step 1
+======
+
+Put the 'dot-well-known' on your website, so it loads at:
+
+ https://example.com/.well-known/
+
+(Remember the . at the beginning of this one, which is common practice
+for "hidden" files and why we have renamed it "dot-")
+
+Step 2
+======
+
+Edit the .well-known/host-meta file and replace "example.com" with the
+domain name you're hosting the .well-known directory on.
+
+Using vim you can do this as a quick method:
+ $ vim .well-known/host-meta [ENTER]
+ :%s/example.com/domain.com/ [ENTER]
+ :wq [ENTER]
+
+Step 3
+======
+
+For each user on your site, and this might only be you...
+
+In the webfinger directory, make a copy of the example@example.com.xml file
+so that it's called (replace username and example.com with appropriate
+values, the domain name should be the same as you're "socialifying"):
+
+ username@example.com.xml
+
+Then edit the file contents, replacing "social.example.com" with your
+GNU social instance's base path, and change the user ID number (and
+nickname for the FOAF link) to that of your account on your social
+site. If you don't know your user ID number, you can see this on your
+GNU social profile page by looking at the destination URLs in the
+Feeds links.
+
+PROTIP: You can get the bulk of the contents (note the <Subject> element though)
+ from curling down your real webfinger data:
+$ curl https://social.example.com/.well-known/webfinger?resource=acct:username@social.example.com
+
+Finally
+=======
+
+Using this method, though fiddly, you can now be @user@domain without
+the need for any prefixes for subdomains, etc.
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0" xmlns:hm="http://host-meta.net/xrd/1.0">
+ <Link rel="lrdd" type="application/xrd+xml"
+ template="https://example.com/.well-known/webfinger?resource={uri}"/>
+</XRD>
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+ <Subject>acct:username@example.com</Subject>
+ <Alias>acct:username@social.example.com</Alias>
+ <Alias>https://social.example.com/user/1</Alias>
+ <Link rel="http://webfinger.net/rel/profile-page"
+ type="text/html"
+ href="https://social.example.com/user/1"/>
+
+ <Link rel="http://schemas.google.com/g/2010#updates-from"
+ type="application/atom+xml"
+ href="https://social.example.com/api/statuses/user_timeline/1.atom"/>
+
+ <!-- Is this/was this ever supported?
+ <Link rel="http://microformats.org/profile/hcard"
+ type="text/html"
+ href="https://social.example.com/hcard"/> -->
+
+ <Link rel="http://gmpg.org/xfn/11"
+ type="text/html"
+ href="https://social.example.com/user/1"/>
+
+ <Link rel="describedby"
+ type="application/rdf+xml"
+ href="https://social.example.com/username/foaf"/>
+
+ <Link rel="http://salmon-protocol.org/ns/salmon-replies"
+ href="https://social.example.com/main/salmon/user/1"/>
+
+ <Link rel="http://salmon-protocol.org/ns/salmon-mention"
+ href="https://social.example.com/main/salmon/user/1"/>
+
+ <Link rel="http://ostatus.org/schema/1.0/subscribe"
+ template="https://social.example.com/main/ostatussub?profile={uri}"/>
+</XRD>
--- /dev/null
+<?php
+
+/*
+ * GNU social
+ * Copyright (C) 2010, Free Software Foundation, Inc
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+// basename should make sure we can't escape this directory
+$u = basename($_GET['resource']);
+
+if (!strpos($u, '@')) {
+ throw new Exception('Bad resource');
+ exit(1);
+}
+
+if (mb_strpos($u, 'acct:')===0) {
+ $u = substr($u, 5);
+}
+
+// Just to be a little bit safer, you know, with all the unicode stuff going on
+$u = filter_var($u, FILTER_SANITIZE_EMAIL);
+
+$f = $u . ".xml";
+
+if (file_exists($f)) {
+ header('Content-Disposition: attachment; filename="'.urlencode($f).'"');
+ header('Content-type: application/xrd+xml');
+ echo file_get_contents($f);
+}
--- /dev/null
+Upgrading
+=========
+
+GNU social 1.1.x to GNU social 1.2.x
+------------------------------------
+
+If you are tracking the GNU social git repository, we currently recommend
+using the "master" branch (or nightly if you want to use latest features)
+and follow this procedure:
+
+0. Backup your data. The StatusNet upgrade discussions below have some
+ guidelines to back up the database and files (mysqldump and rsync).
+
+ MAKE SURE YOU ARE THE SAME USER THAT RUNS THE PHP FILES WHILE PERFORMING
+ THE COMMANDS BELOW (I usually prepend the commands with 'sudo -u social')
+
+1. Stop your queue daemons (you can run this command even if you do not
+ use the queue daemons):
+ $ bash scripts/stopdaemons.sh
+
+2. Run the command to fetch the latest sourcecode:
+ $ git pull
+
+ If you are not using git we recommend following the instructions below
+ for upgrading "StatusNet 1.1.x to GNU social 1.2.x" as they are similar.
+
+3. Run the upgrade script:
+ $ php scripts/upgrade.php
+
+ The upgrade script will likely take a long time because it will
+ upgrade the tables to another character encoding and make other
+ automated upgrades. Make sure it ends without errors. If you get
+ errors, create a new task on https://git.gnu.io/gnu/gnu-social/issues
+
+4. Start your queue daemons again (you can run this command even if you
+ do not use the queue daemons):
+ $ bash scripts/startdaemons.sh
+
+5. Report any issues at https://git.gnu.io/gnu/gnu-social/issues
+
+If you are using ssh keys to log in to your server, you can make this
+procedure pretty painless (assuming you have automated backups already).
+Make sure you "cd" into the correct directory (in this case "htdocs")
+and use the correct login@hostname combo:
+ $ ssh social@domain.example 'cd htdocs
+ && bash scripts/stopdaemons.sh
+ && git pull
+ && time php scripts/upgrade.php
+ && bash scripts/startdaemons.sh'
+
+StatusNet 1.1.x to GNU social 1.2.x
+-----------------------------------
+
+We cannot support migrating from any other version of StatusNet than
+1.1.1. If you are running a StatusNet version lower than this, please
+follow the upgrade procedures for each respective StatusNet version.
+
+You are now running StatusNet 1.1.1 and want to migrate to GNU social
+1.2.x. Beware there may be changes in minimum required version of PHP
+and the modules required, so review the INSTALL file (php5-intl is a
+newly added dependency for example).
+
+* Before you begin: Make backups. Always make backups. Of your entire
+directory structure and the database too. All tables. All data. Alles.
+
+0. Make a backup of everything. To backup the database, you can use a
+variant of this command (you will be prompted for the database password):
+ $ mysqldump -u dbuser -p dbname > social-backup.sql
+
+1. Stop your queue daemons 'bash scripts/stopdaemons.sh' should do it.
+ Not everyone runs queue daemons, but the above command won't hurt.
+
+2. Unpack your GNU social code to a fresh directory. You can do this
+ by cloning our git repository:
+ $ git clone https://git.gnu.io/gnu/gnu-social.git gnusocial
+
+3. Synchronize your local files to the GNU social directory. These
+ will be the local files such as avatars, config and files:
+
+ avatar/*
+ file/*
+ local/*
+ .htaccess
+ config.php
+
+ This command will point you in the right direction on how to do it:
+ $ rsync -avP statusnet/{.htaccess,avatar,file,local,config.php} gnusocial/
+
+4. Replace your old StatusNet directory with the new GNU social
+ directory in your webserver root.
+
+5. Run the upgrade script: 'php scripts/upgrade.php'
+ The upgrade script will likely take a long time because it will
+ upgrade the tables to another character encoding and make other
+ automated upgrades. Make sure it ends without errors. If you get
+ errors, create a new task on https://git.gnu.io/gnu/gnu-social/issues
+
+6. Start your queue daemons: 'bash scripts/startdaemons.sh'
+
+7. Report any issues at https://git.gnu.io/gnu/gnu-social/issues
--- /dev/null
+### GNU social "fancy URL" setup
+#
+# Change the "RewriteBase" in the new .htaccess file to be the URL path
+# to your GNU Social installation on your server. Typically this will
+# be the path to your GNU Social directory relative to your Web root.
+# If you are installing it in the root directory, leave it as '/'.
+#
+# If it doesn't work, double-check that AllowOverride for the GNU Social
+# directory is 'All' in your Apache configuration file. This can be
+# * /etc/apache2/apache2.conf (generic)
+# * /etc/apache2/sites-available/default(on Debian and Ubuntu)
+# * ...many other variations depending on distribution...
+#
+# See the Apache documentation for .htaccess files for more details:
+# https://httpd.apache.org/docs/2.4/howto/htaccess.html
+#
+# Also, check that mod_rewrite is installed and enabled:
+# https://httpd.apache.org/docs/2.4/mod/mod_rewrite.html
+
+
+<IfModule mod_rewrite.c>
+ RewriteEngine On
+
+ # NOTE: change this to your actual GNU social base URL path,
+ # minus the domain part:
+ #
+ # https://social.example.com/ => /
+ # https://example.com/social/ => /social/
+ #
+ RewriteBase /
+ #RewriteBase /mublog/
+
+ ## Uncomment these if having trouble with API authentication
+ ## when PHP is running in CGI or FastCGI mode.
+ #
+ #RewriteCond %{HTTP:Authorization} ^(.*)
+ #RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1]
+
+ RewriteCond %{REQUEST_FILENAME} !-f
+ RewriteCond %{REQUEST_FILENAME} !-d
+ RewriteRule (.*) index.php?p=$1 [L,QSA]
+
+ ## You can also use PATHINFO by using this RewriteRule instead:
+ # RewriteRule (.*) index.php/$1 [L,QSA]
+</IfModule>
+
+<FilesMatch "\.(ini)">
+ <IfVersion < 2.3>
+ Order allow,deny
+ Deny from all
+ </IfVersion>
+ <IfVersion >= 2.3>
+ Require all denied
+ </IfVersion>
+</FilesMatch>
--- /dev/null
+# This is completely optional, but if you're running a site with
+# ssl="always" configured, then you might as well redirect any of
+# your stray HTTP visitors to HTTPS.
+#
+#$HTTP["scheme"] == "http" {
+# $HTTP["host"] =~ "^(social\.example\.com)$" {
+# url.redirect = ( "^\/?(.*)" => "https://%1/$1" )
+# server.name = "%1"
+# }
+#}
+
+# If you're using vhosts, you should have per-vhost server.document-root
+# settings too! Read how in the respective alternative vhost modules.
+#$HTTP["host"] =~ "^social\.example\.com$" {
+
+# NOTE: configure fastcgi/cgi/fpm here if you're using per-user cgi/fpm
+# fastcgi.server += ( ".php" =>
+# ( "localhost" => (
+# "host" => "127.0.0.1",
+# "port" => "9000"
+# ))
+# )
+
+ dir-listing.activate = "disable"
+
+# Make sure "mod_rewrite" is enabled in server.modules
+ url.rewrite-if-not-file = ( "^/(.*)$" => "/index.php/$1" )
+#}
--- /dev/null
+server {
+ listen [::]:80;
+ listen 80;
+
+# FIXME: Change domain name here (and also make sure you do the same in the next 'server' section)
+ server_name social.example.org;
+
+# redirect all traffic to HTTPS
+ rewrite ^ https://$host$request_uri? permanent;
+}
+
+server {
+# HTTPS is mandatory on GNU social unless you are using Tor network. Seriously.
+# Set it up with a cert (any cert) before you run the install.
+ listen [::]:443 ssl http2;
+ listen 443 ssl http2;
+
+# Root
+# FIXME: Change the path below to where you installed GNU social
+ root /path/to/gnusocial/root;
+
+# Server name
+# FIXME: Change "social.example.org" to your site's domain name
+ server_name social.example.org;
+
+# SSL
+# FIXME: Change the paths to setup your SSL key/cert. See https://cipherli.st/ for more information
+ ssl_certificate ssl/certs/social.example.org.crt;
+ ssl_certificate_key ssl/private/social.example.org.key;
+
+# Index
+ index index.php;
+
+# PHP
+ location ^~ /index.php {
+ include fastcgi_params;
+ include snippets/fastcgi-php.conf;
+
+ fastcgi_pass unix:/var/run/php/php-fpm.sock;
+ fastcgi_param SCRIPT_FILENAME $request_filename;
+ }
+
+# Don't allow any PHP file other than index.php to be executed
+# This will ensure that nor config.php nor plugin files with eventual hardcoded security information are downloadable
+# And this is better than allowing php files to be executed in case of forgotten `if (!defined('GNUSOCIAL')) { exit(1); }`
+ location ~ \.php$ {
+ deny all;
+ }
+
+# Location
+ location / {
+ try_files $uri $uri/ @index_handler;
+ }
+
+# Fancy URLs
+ error_page 404 @index_handler;
+ location @index_handler {
+ rewrite ^(.*)$ /index.php?p=$1 last;
+ }
+
+# Restrict access that is unnecessary anyway
+ location ~ /\.(ht|git) {
+ deny all;
+ }
+
+#
+# Hardening (optional)
+#
+# add_header Strict-Transport-Security "max-age=15768000; preload;";
+# add_header X-Content-Type-Options nosniff;
+# add_header Referrer-Policy strict-origin-when-cross-origin;
+# add_header Content-Security-Policy "default-src 'self' 'unsafe-inline'; frame-ancestors 'self'; form-action 'self'; style-src 'self' 'unsafe-inline'; img-src * blob: data:;";
+# add_header X-Permitted-Cross-Domain-Policies none;
+# add_header X-Robots-Tag all; # Not really hardening, just here for strictness purposes
+#
+# client_max_body_size 15M;
+# client_body_buffer_size 128k;
+# gzip_vary on;
+#
+# location ~* \.(?:css|js|woff|svg|gif|png|webp|ttf|ico|jpe?g)$ {
+# gzip on;
+# gzip_comp_level 4;
+# add_header Cache-Control "public";
+# expires 30d;
+# access_log off;
+# log_not_found off;
+# }
+}
+++ /dev/null
-InitializePlugin: a chance to initialize a plugin in a complete environment
-
-CleanupPlugin: a chance to cleanup a plugin at the end of a program
-
-StartActionExecute: Right before the "prepare" call of the current Action
-- $action: the current Action object
-- &$args: array of arguments, referenced so you can modify the array
-
-EndActionExecute: Right after the "handle" call of the current Action
-- $action: the current Action object
-
-StartPrimaryNav: Showing the primary nav menu
-- $action: the current action
-
-EndPrimaryNav: At the end of the primary nav menu
-- $action: the current action
-
-StartSecondaryNav: Showing the secondary nav menu
-- $action: the current action
-
-EndSecondaryNav: At the end of the secondary nav menu
-- $action: the current action
-
-StartShowStyles: Showing Style links; good place to add UA style resets
-- $action: the current action
-
-EndShowStyles: End showing Style links; good place to add custom styles
-- $action: the current action
-
-StartShowStylesheets: Showing stylesheet links
-- $action: the current action
-
-EndShowStylesheets: End showing stylesheet links; good place to add handheld or JavaScript dependant styles
-- $action: the current action
-
-StartShowUAStyles: Showing custom User-Agent style links
-- $action: the current action
-
-EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
-- $action: the current action
-
-StartShowScripts: Showing JavaScript links
-- $action: the current action
-
-EndShowScripts: End showing JavaScript links; good place to add custom links
-- $action: the current action
-
-StartShowJQueryScripts: Showing JQuery script links
-- $action: the current action
-
-EndShowJQueryScripts: End showing JQuery script links
-- $action: the current action
-
-StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
-- $action: the current action
-
-EndShowStatusNetScripts: End showing StatusNet script links
-- $action: the current action
-
-StartShowSections: Start the list of sections in the sidebar
-- $action: the current action
-
-EndShowSections: End the list of sections in the sidebar
-- $action: the current action
-
-StartShowHeader: Showing before the header container
-- $action: the current action
-
-EndShowHeader: Showing after the header container
-- $action: the current action
-
-StartShowFooter: Showing before the footer container
-- $action: the current action
-
-EndShowFooter: Showing after the footer container
-- $action: the current action
-
-StartShowContentBlock: Showing before the content container
-- $action: the current action
-
-EndShowContentBlock: Showing after the content container
-- $action: the current action
-
-StartShowAside: Showing before the Aside container
-- $action: the current action
-
-EndShowAside: Showing after the Aside container
-- $action: the current action
-
-StartShowNoticeFormData: Showing before the notice form data
-- $action: the current action
-
-EndShowNoticeFormData: Showing after the notice form data
-- $action: the current action
-
-StartNoticeSave: before inserting a notice (good place for content filters)
-- $notice: notice being saved (no ID or URI)
-
-EndNoticeSave: after inserting a notice and related code
-- $notice: notice that was saved (with ID and URI)
-
-StartShowLocalNavBlock: Showing the local nav menu
-- $action: the current action
-
-EndShowLocalNavBlock: At the end of the local nav menu
-- $action: the current action
-
-StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
-- $action: the current action
-
-EndShowHTML: Showing after the html element
-- $action: the current action
-
-StartPublicGroupNav: Showing the public group nav menu
-- $menu: the menu widget; use $menu->action for output
-
-EndPublicGroupNav: At the end of the public group nav menu
-- $menu: the menu widget; use $menu->action for output
-
-StartSubGroupNav: Showing the subscriptions group nav menu
-- $menu: the menu widget; use $menu->action for output
-
-EndSubGroupNav: At the end of the subscriptions group nav menu
-- $menu: the menu widget; use $menu->action for output
-
-StartInitializeRouter: Before the router instance has been initialized; good place to add routes
-- $m: the Net_URL_Mapper that has just been set up
-
-RouterInitialized: After the router instance has been initialized
-- $m: the Net_URL_Mapper that has just been set up
-
-StartLogout: Before logging out
-- $action: the logout action
-
-EndLogout: After logging out
-- $action: the logout action
-
-ArgsInitialize: After the argument array has been initialized
-- $args: associative array of arguments, can be modified
-
-StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
-- $action: the current action
-
-EndAddressData: At the end of <address>
-- $action: the current action
-
-StartShowSiteNotice: Before showing site notice
-- $action: the current action
-
-EndShowSiteNotice: After showing site notice
-- $action: the current action
-
-StartLoginGroupNav: Before showing the login and register navigation menu
-- $action: the current action
-
-EndLoginGroupNav: After showing the login and register navigation menu
-- $action: the current action
-
-StartAccountSettingsNav: Before showing the account settings menu
-- $action: the current action
-
-EndAccountSettingsNav: After showing the account settings menu
-- $action: the current action
-
-StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
-- $widget: AccountSettingsNav instance being shown
-
-EndAccountSettingsProfileMenuItem: After showing the Profile menu item
-- $widget: AccountSettingsNav instance being shown
-
-StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
-- $widget: AccountSettingsNav instance being shown
-
-EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
-- $widget: AccountSettingsNav instance being shown
-
-StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
-- $widget: AccountSettingsNav instance being shown
-
-EndAccountSettingsPasswordMenuItem: After showing the Password menu item
-- $widget: AccountSettingsNav instance being shown
-
-StartAccountSettingsEmailMenuItem: Before showing the Email menu item
-- $widget: AccountSettingsNav instance being shown
-
-EndAccountSettingsEmailMenuItem: After showing the Email menu item
-- $widget: AccountSettingsNav instance being shown
-
-StartAccountSettingsDesignMenuItem: Before showing the Design menu item
-- $widget: AccountSettingsNav instance being shown
-
-EndAccountSettingsDesignMenuItem: After showing the Design menu item
-- $widget: AccountSettingsNav instance being shown
-
-StartAccountSettingsOtherMenuItem: Before showing the Other menu item
-- $widget: AccountSettingsNav instance being shown
-
-EndAccountSettingsOtherMenuItem: After showing the Other menu item
-- $widget: AccountSettingsNav instance being shown
-
-Autoload: When trying to autoload a class
-- $cls: the class being sought. A plugin might require_once the file for the class.
-
-SensitiveAction: determines if an action is 'sensitive' and should use SSL
-- $action: name of the action, like 'login'
-- $sensitive: flag for whether this is a sensitive action
-
-LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
-- $action: name of the action, like 'register'
-- $login: flag for whether this is a login action
-
-StartShowHead: called before showing the <head> element and children
-- $action: action object being show
-
-EndShowHead: called after showing the <head> element (and </head>)
-- $action: action object being shown
-
-StartShowBody: called before showing the <body> element and children
-- $action: action object being shown
-
-EndShowBody: called after showing the <body> element (and </body>)
-- $action: action object being shown
-
-StartPersonalGroupNav: beginning of personal group nav menu
-- $menu: Menu list object being shown
-- $target: Profile for whom it is shown
-- $scoped: Profile of currently logged in user (or null)
-
-EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
-- $action: action object being shown
-
-StartGroupGroupNav: Showing the group nav menu
-- $action: the current action
-
-EndGroupGroupNav: At the end of the group nav menu
-- $action: the current action
-
-StartEndHTML: just before the </html> tag
-- $action: action object being shown
-
-EndEndHTML: just after the </html> tag
-- $action: action object being shown
-
-FinalAction: After prepare() (and possible handle) in Action class.
-- $status: result of "prepare" call on action
-- $action: Action that is currently running
-
-StartShowDesign: just before showing a site, user, or group design
-- $action: action object being shown
-
-EndShowDesign: just after showing a site, user, or group design
-- $action: action object being shown
-
-StartShowExportData: just before showing the <div> with export data (feeds)
-- $action: action object being shown
-
-EndShowExportData: just after showing the <div> with export data (feeds)
-- $action: action object being shown
-
-StartShowNoticeItem: just before showing the notice item
-- $item: The NoticeListItem object being shown
-
-EndShowNoticeItem: just after showing the notice item
-- $item: the NoticeListItem object being shown
-
-StartShowNoticeItemNotice: just before outputting the "top" notice part of a NoticeListItem to HTML
-- $item: The NoticeListItem object being shown
-
-EndShowNoticeItemNotice: just after outputting the "top" notice part of a NoticeListItem to HTML
-- $item: The NoticeListItem object being shown
-
-StartShowNoticeContent: just before outputting the content part of a Notice
-- $stored: The Notice object
-- $out: HTMLOutputter for writing to
-- $scoped: optional Profile object for permission scoping
-
-EndShowNoticeContent: just after outputting the content part of a Notice, plugins must call this manually
-- $stored: The Notice object
-- $out: HTMLOutputter for writing to
-- $scoped: optional Profile object for permission scoping
-
-StartShowNoticeInfo: just before showing notice info
-- $item: The NoticeListItem object being shown
-
-EndShowNoticeInfo: just after showing notice info
-- $item: The NoticeListItem object being shown
-
-StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.
-- $item: the NoticeListItem object being shown
-
-EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
-- $item: the NoticeListItem object being shown
-
-StartShowPageNotice: just before showing the page notice (instructions or error)
-- $action: action object being shown
-
-EndShowPageNotice: just after showing the page notice (instructions or error)
-- $action: action object being shown
-
-StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
-- $action: action object being shown
-
-StartProfileFormData: just before showing text entry fields on profile settings page
-- $action: action object being shown
-
-EndProfileFormData: just after showing text entry fields on profile settings page
-- $action: action object being shown
-
-StartProfileSaveForm: before starting to save a profile settings form
-- $action: action object being shown
-
-EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
-- $action: action object being shown
-
-StartEmailFormData: just before showing form input fields on email settings page
-- $action: Action object being shown
-- $scoped: Profile for whom settings are being configured
-
-EndEmailFormData: just after showing form input fields on email settings page
-- $action: action object being shown
-- $scoped: Profile for whom settings are being configured
-
-StartEmailSaveForm: before starting to save a email settings form
-- $action: action object being shown
-- $scoped: Profile user having their email settings saved
-
-EndEmailSaveForm: after saving a email settings form (after commit)
-- $action: action object being shown
-- $scoped: Profile user having their email settings saved
-
-StartRegistrationFormData: just before showing text entry fields on registration page
-- $action: action object being shown
-
-EndRegistrationFormData: just after showing text entry fields on registration page
-- $action: action object being shown
-
-StartRegistrationTry: before validating and saving a new user
-- $action: action object being shown
-
-EndRegistrationTry: after saving a new user (note: no profile or user object!)
-- $action: action object being shown
-
-StartAvatarFormData: before displaying avatar form
-- $action: action object being shown
-
-EndAvatarFormData: after displaying avatar form
-- $action: action object being shown
-
-StartAvatarSaveForm: before saving the avatar
-- $action: action object being shown
-
-EndAvatarSaveForm: after saving the avatar
-- $action: action object being shown
-
-StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
-- $qm: empty queue manager to set
-
-RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
-- $action: action object being shown
-- $user: current user
-
-StartLoadDoc: before loading a help doc (hook this to show your own documentation)
-- $title: title of the document
-- $output: HTML output to show
-
-EndLoadDoc: after loading a help doc (hook this to modify other documentation)
-- $title: title of the document
-- $output: HTML output to show
-
-StartApiRss: after the rss <channel> element is started
-- $action: action object being shown
-
-StartApiAtom: after the <feed> element is started
-- $action: action object being shown
-
-StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
-- $notice: the notice being added
-- &$transports: modifiable list of transports (as strings) to queue for
-
-EndEnqueueNotice: after adding a notice to the queues
-- $notice: the notice being added
-- $transports: modifiable list of transports to use
-
-UnqueueHandleNotice: Handle a notice when no queue manager is available
-- $notice: the notice to handle
-- $queue: the "queue" that is being executed
-
-GetValidDaemons: Just before determining which daemons to run
-- &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
-
-HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
-- &$notice: notice to handle
-
-StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces
-- $action: the current action
-- &$attrs: attributes for the HTML element
-
-EndHtmlElement: Right after outputting the HTML element
-- $action: the current action
-- &$attrs: attributes for the HTML element
-
-StartShowHeadElements: Right after the <head> tag
-- $action: the current action
-
-EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
-- $action: the current action
-
-CheckSchema: chance to check the schema
-
-StartProfileRemoteSubscribe: Before showing the link to remote subscription
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfileRemoteSubscribe: After showing the link to remote subscription
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartGroupSubscribe: Before showing the link to remote subscription
-- $action: the current action
-- $group: the group being shown
-
-EndGroupSubscribe: After showing the link to remote subscription
-- $action: the current action
-- $group: the group being shown
-
-StartProfilePageProfileSection: Starting to show the section of the
- profile page with the actual profile data;
- hook to prevent showing the profile (e.g.)
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartProfilePageProfileElements: inside the section, before the first
- element; prepend elements here
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfilePageProfileElements: inside the section, after the last element;
- append elements here
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfilePageProfileSection: After showing the section of the profile
- page with the profile elements
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartProfilePageActionsSection: Starting to show the section of the
- profile page with action links; hook
- to hide them (for example)
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartProfilePageActionsElements: inside the list, before the first
- element; prepend elements here
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfilePageActionsElements: inside the list, after the last element;
- append elements here
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfilePageActionsSection: After showing the section of the profile
- page with the entity actions
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartProfilePageAvatar: before showing the avatar on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfilePageAvatar: after showing the avatar on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartProfilePageNickname: before showing the nickname on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfilePageNickname: after showing the nickname on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartProfilePageFullName: before showing the fullname on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfilePageFullName: after showing the fullname on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartProfilePageLocation: before showing the location on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfilePageLocation: after showing the location on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartProfilePageHomepage: before showing the homepage link on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfilePageHomepage: after showing the homepage on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartProfilePageBio: before showing the bio on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfilePageBio: after showing the bio on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartProfilePageProfileTags: before showing the tags on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-EndProfilePageProfileTags: after showing the tags on the profile page
-- $userprofile: UserProfile widget
-- &$profile: the profile being shown
-
-StartProfileList: when starting a list of profiles (before <ul>)
-- $profilelist: ProfileList widget, with $profile, $action, and $out
-
-EndProfileList: when ending a list of profiles (after </ul>)
-- $profilelist: ProfileList widget
-
-StartProfileListItem: when starting to show a profile list item
-- $item: ProfileListItem widget
-
-EndProfileListItem: after showing a profile list item
-- $item: ProfileListItem widget
-
-StartProfileListItemProfile: the profile data part of the item
-- $item: ProfileListItem widget
-
-EndProfileListItemProfile: the profile data part of the item
-- $item: ProfileListItem widget
-
-StartProfileListItemActions: the actions (buttons) for an item
-- $item: ProfileListItem widget
-
-EndProfileListItemActions: the actions (buttons) for an item
-- $item: ProfileListItem widget
-
-StartProfileListItemProfileElements: inside the <div>
-- $item: ProfileListItem widget
-
-EndProfileListItemProfileElements: inside the <div>
-- $item: ProfileListItem widget
-
-StartProfileListItemAvatar: Showing a profile list avatar
-- $item: ProfileListItem widget
-
-EndProfileListItemAvatar: Showing a profile list avatar
-- $item: ProfileListItem widget
-
-StartProfileListItemFullName: Showing the profile list full name
-- $item: ProfileListItem widget
-
-EndProfileListItemFullName: Showing the profile list full name
-- $item: ProfileListItem widget
-
-StartProfileListItemLocation: Showing the profile list location
-- $item: ProfileListItem widget
-
-EndProfileListItemLocation: Showing the profile list location
-- $item: ProfileListItem widget
-
-StartProfileListItemHomepage: Showing the profile list homepage
-- $item: ProfileListItem widget
-
-EndProfileListItemHomepage: Showing the profile list homepage
-- $item: ProfileListItem widget
-
-StartProfileListItemBio: Showing the profile list bio
-- $item: ProfileListItem widget
-
-EndProfileListItemBio: Showing the profile list bio
-- $item: ProfileListItem widget
-
-StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
-- $item: ProfileListItem widget
-
-EndProfileListItemActionElements: Showing profile list actions (append a button here)
-- $item: ProfileListItem widget
-
-StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
-- $action: the current action
-- &$xrdsoutputter - XRDSOutputter object to write to
-
-EndUserXRDS: End XRDS output (right before the closing XRDS tag)
-- $action: the current action
-- &$xrdsoutputter - XRDSOutputter object to write to
-
-StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
-- $action: the current action
-- &$xrdsoutputter - XRDSOutputter object to write to
-
-EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
-- $action: the current action
-- &$xrdsoutputter - XRDSOutputter object to write to
-
-StartCheckPassword: Check a username/password
-- $nickname: The nickname to check
-- $password: The password to check
-- &$authenticatedUser: set to User object if credentials match a user.
-
-EndCheckPassword: After checking a username/password pair
-- $nickname: The nickname that was checked
-- $password: The password that was checked
-- $authenticatedUser: User object if credentials match a user, else null.
-
-StartChangePassword: Before changing a password
-- Profile $target: The profile of the User that is changing password
-- $oldpassword: the user's old password
-- $newpassword: the desired new password
-
-EndChangePassword: After changing a password
-- Profile $target: The profile of the User that just changed its password
-
-StartHashPassword: Generate a hashed version of the password (like a salted crypt)
-- &$hashed: Hashed version of the password, later put in the database
-- $password: The password that should be hashed
-- $profile: Profile that this password and hash belongs to. Can be null.
-
-StartSetUser: Before setting the currently logged in user
-- $user: user
-
-EndSetUser: After setting the currently logged in user
-- $user: user
-
-StartSetApiUser: Before setting the current API user
-- &$user: user, can be set during event handling (return false to stop processing)
-
-EndSetApiUser: After setting the current API user
-- $user: user, only called if this is an actual user
-
-StartHasRole: Before determing if the a profile has a given role
-- $profile: profile in question
-- $name: name of the role in question
-- &$has_role: does this profile have the named role?
-
-EndHasRole: Before determing if the a profile has a given role
-- $profile: profile in question
-- $name: name of the role in question
-- $has_role: does this profile have the named role?
-
-UserDeleteRelated: Specify additional tables to delete entries from when deleting users
-- $user: User object
-- &$related: array of DB_DataObject class names to delete entries on matching user_id.
-
-GetUrlShorteners: Specify URL shorteners that are available for use
-- &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
-
-StartShortenUrl: About to shorten a URL
-- $url: url to be shortened
-- $shortenerName: name of the requested shortener
-- &$shortenedUrl: short version of the url
-
-EndShortenUrl: After a URL has been shortened
-- $url: url to be shortened
-- $shortenerName: name of the requested shortener
-- $shortenedUrl: short version of the url
-
-StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
-- $action
-- &$src
-- &$theme
-- &$media
-
-EndCssLinkElement: After a <link rel="stylesheet"..> element is written
-- $action
-- $src
-- $theme
-- $media
-
-StartStyleElement: Before a <style...> element is written
-- $action
-- &$code
-- &$type
-- &$media
-
-EndStyleElement: After a <style...> element is written
-- $action
-- $code
-- $type
-- $media
-
-StartScriptElement: Before a <script...> element is written
-- $action
-- &$src
-- &$type
-
-EndScriptElement: After a <script...> element is written
-- $action
-- $src
-- $type
-
-StartInlineScriptElement: Before a <script...> element is written
-- $action
-- &$code
-- &$type
-
-EndInlineScriptElement: After a <script...> element is written
-- $action
-- $code
-- $type
-
-StartLog: Before writing to the logs
-- &$priority
-- &$msg
-- &$filename
-
-EndLog: After writing to the logs
-- $priority
-- $msg
-- $filename
-
-StartBlockProfile: when we're about to block
-- $user: the person doing the block
-- $profile: the person getting blocked, can be remote
-
-EndBlockProfile: when a block has succeeded
-- $user: the person doing the block
-- $profile: the person blocked, can be remote
-
-StartUnblockProfile: when we're about to unblock
-- $user: the person doing the unblock
-- $profile: the person getting unblocked, can be remote
-
-EndUnblockProfile: when an unblock has succeeded
-- $user: the person doing the unblock
-- $profile: the person unblocked, can be remote
-
-StartSubscribe: when a subscription is starting
-- $profile: Profile that is subscribing
-- $other: Profile that is being subscribed to
-
-EndSubscribe: when a subscription is finished
-- $profile: Profile that is subscribing
-- $other: Profile that is being subscribed to
-
-StartUnsubscribe: when an unsubscribe is starting
-- $profile: Profile that is unsubscribing
-- $other: Profile that is being unsubscribed from
-
-EndUnsubscribe: when an unsubscribe is done
-- $profile: Profile that is unsubscribing
-- $other: Profile that is being unsubscribed from
-
-StartJoinGroup: when a user is joining a group
-- $group: the group being joined
-- $profile: the local or remote user joining
-
-EndJoinGroup: when a user finishes joining a group
-- $group: the group being joined
-- $profile: the local or remote user joining
-
-StartLeaveGroup: when a user is leaving a group
-- $group: the group being left
-- $profile: the local or remote user leaving
-
-EndLeaveGroup: when a user has left a group
-- $group: the group being left
-- $profile: the local or remote user leaving
-
-StartShowContentLicense: Showing the default license for content
-- $action: the current action
-
-EndShowContentLicense: Showing the default license for content
-- $action: the current action
-
-GetImTransports: Get IM transports that are available
-- &$transports: append your transport to this array like so: $transports[transportName]=array('display'=>display)
-
-NormalizeImScreenname: Normalize an IM screenname
-- $transport: transport the screenname is on
-- &$screenname: screenname to be normalized
-
-ValidateImScreenname: Validate an IM screenname
-- $transport: transport the screenname is on
-- $screenname: screenname to be validated
-- $valid: is the screenname valid?
-
-SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname
-- $transport: transport the screenname exists on
-- $screenname: screenname being confirmed
-- $code: confirmation code for confirmation URL
-- $user: user requesting the confirmation
-
-StartUserRegister: When a new user is being registered
-- $profile: Profile object with new profile data (no ID yet)
-
-EndUserRegister: When a new user has been registered
-- $profile: Profile object with new profile data
-
-StartRobotsTxt: Before outputting the robots.txt page
-- &$action: RobotstxtAction being shown
-
-EndRobotsTxt: After the default robots.txt page (good place for customization)
-- &$action: RobotstxtAction being shown
-
-StartGetProfileUri: When determining the canonical URI for a given profile
-- $profile: the current profile
-- &$uri: the URI
-
-EndGetProfileUri: After determining the canonical URI for a given profile
-- $profile: the current profile
-- &$uri: the URI
-
-StartGetProfileAcctUri: Get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
-- $profile: Profile of user we want to get acct: URI for
-- &$acct: string with the resulting acct: uri
-
-EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
-- $profile: Profile of user we want to get acct: URI for
-- &$acct: string with the resulting acct: uri
-
-StartFindMentions: start finding mentions in a block of text
-- $sender: sender profile
-- $text: plain text version of the notice
-- &$mentions: mentions found so far. Array of arrays; each array
- has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
- 'title' (title of the link), 'position' (position of the text to
- replace), 'text' (text to replace)
-
-EndFindMentions: end finding mentions in a block of text
-- $sender: sender profile
-- $text: plain text version of the notice
-- &$mentions: mentions found so far. Array of arrays; each array
- has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
- 'title' (title of the link), 'position' (position of the text to
- replace), 'text' (text to replace)
-
-StartShowSubscriptionsContent: before showing the subscriptions content
-- $action: the current action
-
-EndShowSubscriptionsContent: after showing the subscriptions content
-- $action: the current action
-
-StartShowUserGroupsContent: before showing the user groups content
-- $action: the current action
-
-EndShowUserGroupsContent: after showing the user groups content
-- $action: the current action
-
-StartShowAllContent: before showing the all (you and friends) content
-- $action: the current action
-
-EndShowAllContent: after showing the all (you and friends) content
-- $action: the current action
-
-StartShowSubscriptionsMiniList: at the start of subscriptions mini list
-- $action: the current action
-
-EndShowSubscriptionsMiniList: at the end of subscriptions mini list
-- $action: the current action
-
-StartShowGroupsMiniList: at the start of groups mini list
-- $action: the current action
-
-EndShowGroupsMiniList: at the end of groups mini list
-- $action: the current action
-
-StartDeleteUserForm: starting the data in the form for deleting a user
-- $action: action being shown
-- $user: user being deleted
-
-EndDeleteUserForm: Ending the data in the form for deleting a user
-- $action: action being shown
-- $user: user being deleted
-
-StartDeleteUser: handling the post for deleting a user
-- $action: action being shown
-- $user: user being deleted
-
-EndDeleteUser: handling the post for deleting a user
-- $action: action being shown
-- $user: user being deleted
-
-StartNoticeAsActivity: before converting a notice to an activity
-- $notice: notice being converted
-- &$activity: initially empty activity
-
-EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)
-- $notice: notice being converted
-- &$activity: activity, now more-or-less full
-
-StartNoticeSaveWeb: before saving a notice through the Web interface
-- $action: action being executed (instance of NewNoticeAction)
-- &$authorId: integer ID of the author
-- &$text: text of the notice
-- &$options: additional options (location, replies, etc.)
-
-EndNoticeSaveWeb: after saving a notice through the Web interface
-- $action: action being executed (instance of NewNoticeAction)
-- $notice: notice that was saved
-
-StartRssEntryArray: at the start of copying a notice to an array
-- $notice: the notice being copied
-- &$entry: the entry (empty at beginning)
-
-EndRssEntryArray: at the end of copying a notice to an array
-- $notice: the notice being copied
-- &$entry: the entry, with all the fields filled up
-
-NoticeDeleteRelated: at the beginning of deleting related fields to a notice
-- $notice: notice being deleted
-
-FileDeleteRelated: at the beginning of deleting related fields to a File
-- $notice: File being deleted
-
-StartShowHeadTitle: when beginning to show the <title> element
-- $action: action being shown
-
-EndShowHeadTitle: when done showing the <title>
-- $action: action being shown
-
-StartShowPageTitle: when beginning to show the page title <h1>
-- $action: action being shown
-
-EndShowPageTitle: when done showing the page title <h1>
-- $action: action being shown
-
-StartDeleteOwnNotice: when a user starts to delete their own notice
-- $user: the user doing the delete
-- $notice: the notice being deleted
-
-EndDeleteOwnNotice: when a user has deleted their own notice
-- $user: the user doing the delete
-- $notice: the notice being deleted
-
-StartShowFeedLinkList: before showing the feed list in the sidebar
-- $action: action being executed
-- $feeds: list of feeds to show
-
-EndShowFeedLinkList: after showing the feed list in the sidebar
-- $action: action being executed
-- $feeds: list of feeds shown
-
-StartShowFeedLink: before showing an individual feed item
-- $action: action being executed
-- $feed: feed to show
-
-EndShowFeedLink: after showing an individual feed
-- $action: action being executed
-- $feed: feed to show
-
-StartShowNoticeForm: before showing the notice form (before <form>)
-- $action: action being executed
-
-EndShowNoticeForm: after showing the notice form (after <form>)
-- $action: action being executed
-
-StartShowEntryForms: microapp entry form tab data
-- &$tabs: tab assoc array with 'tag' => (title, href to create new entry)
-
-StartGrantRole: when a role is being assigned
-- $profile: profile that will have the role
-- $role: string name of the role
-
-EndGrantRole: when a role has been successfully assigned
-- $profile: profile that will have the role
-- $role: string name of the role
-
-StartRevokeRole: when a role is being revoked
-- $profile: profile that will lose the role
-- $role: string name of the role
-
-EndRevokeRole: when a role has been revoked
-- $profile: profile that lost the role
-- $role: string name of the role
-
-StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
-- &$activity: received activity
-- $profile: profile of the user publishing the entry
-- &$notice: notice created; initially null, can be set
-
-EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
-- $activity: received activity
-- $profile: profile of the user publishing the entry
-- $notice: notice that was created
-
-AdminPanelCheck: When checking whether the current user can access a given admin panel
-- $name: Name of the admin panel
-- &$isOK: Boolean whether the user is allowed to use the panel
-
-StartAdminPanelNav: Before displaying the first item in the list of admin panels
-- $nav The AdminPanelNav widget
-
-EndAdminPanelNav: After displaying the last item in the list of admin panels
-- $nav The AdminPanelNav widget
-
-StartActivityObjectFromNotice: When converting a notice to an activity:object
-- $notice: The notice being converted
-- &$object: The resulting object. Fill this and return false to override defaults.
-
-EndActivityObjectFromNotice: After converting a notice to an activity:object
-- $notice: The notice being converted
-- &$object: The resulting object. Can be edited
-
-StartActivityObjectFromProfile: When converting a profile to an activity:object
-- $profile: The profile being converted
-- &$object: The (empty) object. Fill it up and return false to override defaults.
-
-EndActivityObjectFromProfile: After converting a profile to an activity:object
-- $profile: The profile being converted
-- &$object: The finished object. Can be tweaked
-
-StartActivityObjectFromGroup: When converting a group to an activity:object
-- $group: The group being converted
-- &$object: The (empty) object. Fill and return false to override.
-
-EndActivityObjectFromGroup: After converting a group to an activity:object
-- $group: The group being converted
-- &$object: The finished object. Tweak as needed.
-
-StartImportActivity: when we start to import an activity
-- $user: User to make the author import
-- $author: Author of the feed; good for comparisons
-- $activity: The current activity
-- $trusted: How "trusted" the process is
-- &$done: Return value; whether to continue
-
-EndImportActivity: when we finish importing an activity
-- $user: User to make the author import
-- $author: Author of the feed; good for comparisons
-- $activity: The current activity
-- $trusted: How "trusted" the process is
-
-StartProfileSettingsActions: when we're showing account-management action list
-- $action: Action being shown (use for output)
-
-EndProfileSettingsActions: when we're showing account-management action list
-- $action: Action being shown (use for output)
-
-StartOpenNoticeListItemElement: Before the opening <li> of a notice list element
-- $nli: The notice list item being shown
-
-EndOpenNoticeListItemElement: After the opening <li> of a notice list element
-- $nli: The notice list item being shown
-
-StartCloseNoticeListItemElement: Before the closing </li> of a notice list element
-- $nli: The notice list item being shown
-
-EndCloseNoticeListItemElement: After the closing </li> of a notice list element
-- $nli: The notice list item being shown
-
-StartGroupEditFormData: Beginning the group edit form entries
-- $form: The form widget being shown
-
-EndGroupEditFormData: Ending the group edit form entries
-- $form: The form widget being shown
-
-StartGroupSave: After initializing but before saving a group
-- &$group: group about to be saved
-
-EndGroupSave: After saving a group, aliases, and first member
-- $group: group that was saved
-
-StartInterpretCommand: Before running a command
-- $cmd: First word in the string, 'foo' in 'foo argument'
-- $arg: Argument, if any, like 'argument' in 'foo argument'
-- $user: User who issued the command
-- &$result: Resulting command; you can set this!
-
-EndInterpretCommand: Before running a command
-- $cmd: First word in the string, 'foo' in 'foo argument'
-- $arg: Argument, if any, like 'argument' in 'foo argument'
-- $user: User who issued the command
-- $result: Resulting command
-
-StartGroupActionsList: Start the list of actions on a group profile page (after <ul>, before first <li>)
-- $action: action being executed (for output and params)
-- $group: group for the page
-
-EndGroupActionsList: End the list of actions on a group profile page (before </ul>, after last </li>)
-- $action: action being executed (for output and params)
-- $group: group for the page
-
-StartGroupProfileElements: Start showing stuff about the group on its profile page
-- $action: action being executed (for output and params)
-- $group: group for the page
-
-EndGroupProfileElements: Start showing stuff about the group on its profile page
-- $action: action being executed (for output and params)
-- $group: group for the page
-
-StartShowProfileTagContent: When showing a people tag page
-- $action: action being executed (for output and params)
-
-EndShowProfileTagContent: After showing the contents of a people tag page
-- $action: action being executed (for output and params)
-
-StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles
-- $action: action being executed (for output and params)
-
-EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles
-- $action: action being executed (for output and params)
-
-StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers
-- $action: action being executed (for output and params)
-
-EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers
-- $action: action being executed (for output and params)
-
-StartTagProfileAction: When starting to show profile tagging page
-- $action: action being executed (for output and params)
-- $profile: profile being tagged
-
-EndTagProfileAction: After showing profile tagging page
-- $action: action being executed (for output and params)
-- $profile: profile being tagged
-
-StartProfileCompletionSearch: When starting a profile search for autocompletion
-- $action: action being executed (for output and params)
-- &$profile: result Profile objects
-- $search_engine: the search engine
-
-EndProfileCompletionSearch: After search results for profile autocompletion have been found
-- $action: profilec completion action
-- &$profile: current result Profile objects
-- $search_engine: The search engine object
-
-StartShowTagProfileForm: When showing people tagging form
-- $action: action being executed (for output and params)
-- $profile: profile being tagged
-
-EndShowTagProfileForm: After showing people tagging form
-- $action: action being executed (for output and params)
-- $profile: profile being tagged
-
-StartSavePeopletags: When starting to save people tags
-- $action: action being executed (for output and params)
-- $tagstring: string input, a list of tags
-
-EndSavePeopletags: After saving people tags
-- $action: action being executed (for output and params)
-- $tagstring: string input, a list of tags
-
-StartProfiletagGetUri: when generating the Uri for a people tag
-- $profile_list: the people tag, a Profile_list object
-- &$uri: the URI
-
-EndProfiletagGetUri: after generating the uri for a people tag
-- $profile_list: the people tag, a Profile_list object
-- &$uri: the URI
-
-StartUserPeopletagHomeUrl: when generating the homepage url for a people tag
-- $profile_list: the people tag, a Profile_list object
-- &$url: the URL
-
-EndUserPeopletagHomeUrl: after generating the homepage url for a people tag
-- $profile_list: the people tag, a Profile_list object
-- &$url: the URL
-
-StartProfiletagPermalink: when generating the permalink url for a people tag
-- $profile_list: the people tag, a Profile_list object
-- &$url: the URL
-
-EndProfiletagPermalink: after generating the permalink url for a people tag
-- $profile_list: the people tag, a Profile_list object
-- &$url: the URL
-
-StartTagProfile: when tagging a profile
-- $tagger: profile tagging
-- $tagged: profile being tagged
-- $tag: the tag
-
-EndTagProfile: after tagging a profile
-- $newtag: the newly created Profile_tag object
-
-StartUntagProfile: when deleting a people tag
-- $ptag: the Profile_tag object being deleted
-
-EndUntagProfile: after deleting a people tag
-- $orig: a copy of the deleted Profile_tag object
-
-StartSubscribePeopletag: when subscribing to a people tag
-- $peopletag: Profile_list object being subscribed to
-- $profile: subscriber's profile
-
-EndSubscribePeopletag: after subscribing to a people tag
-- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
-- $profile: subscriber's profile
-
-StartUnsubscribePeopletag: when unsubscribing to a people tag
-- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
-- $profile: subscriber's profile
-
-EndUnsubscribePeopletag: after unsubscribing to a people tag
-- $peopletag: Profile_list object being subscribed to
-- $profile: subscriber's profile
-
-StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag
-- $profile_list: the people tag, a Profile_list object
-- &$object: activity object
-
-EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag
-- $profile_list: the people tag, a Profile_list object
-- &$object: activity object
-
-StartPeopletagGroupNav: Showing the people tag nav menu
-- $menu: the menu widget; use $menu->action for output
-
-EndPeopletagGroupNav: after showing the people tag nav menu
-- $menu: the menu widget; use $menu->action for output
-
-StartShowPeopletagItem: when showing a people tag
-- $widget: PeopletagListItem widget
-
-EndShowPeopletagItem: after showing a people tag
-- $widget: PeopletagListItem widget
-
-StartSubscribePeopletagForm: when showing people tag subscription form
-- $action: action being executed (for output and params)
-- $peopletag: people tag being subscribed to
-
-EndSubscribePeopletagForm: after showing the people tag subscription form
-- $action: action being executed (for output and params)
-- $peopletag: people tag being subscribed to
-
-StartShowPeopletags: when showing a textual list of people tags
-- $widget: PeopletagsWidget; use $widget->out for output
-- $tagger: profile of the tagger
-- $tagged: profile tagged
-
-EndShowPeopletags: after showing a textual list of people tags
-- $widget: PeopletagsWidget; use $widget->out for output
-- $tagger: profile of the tagger
-- $tagged: profile tagged
-
-StartProfileListItemTags: when showing people tags in a profile list item widget
-- $widget: ProfileListItem widget
-
-EndProfileListItemTags: after showing people tags in a profile list item widget
-- $widget: ProfileListItem widget
-
-StartActivityObjectOutputAtom: Called at start of Atom XML output generation for ActivityObject chunks, just inside the <activity:object>. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
-- $obj: ActivityObject
-- $out: XMLOutputter to append custom output
-
-EndActivityObjectOutputAtom: Called at end of Atom XML output generation for ActivityObject chunks, just inside the </activity:object>
-- $obj: ActivityObject
-- $out: XMLOutputter to append custom output
-
-StartActivityObjectOutputJson: Called at start of JSON output generation for ActivityObject chunks: the array has not yet been filled out. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
-- $obj ActivityObject
-- &$out: array to be serialized; you're free to modify it
-
-EndActivityObjectOutputJson: Called at end of JSON output generation for ActivityObject chunks: the array has not yet been filled out.
-- $obj ActivityObject
-- &$out: array to be serialized; you're free to modify it
-
-StartNoticeWhoGets: Called at start of inbox delivery prep; plugins can schedule notices to go to particular profiles that would otherwise not have reached them. Canceling will take over the entire addressing operation. Be aware that output can be cached or used several times, so should remain idempotent.
-- $notice Notice
-- &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
-
-EndNoticeWhoGets: Called at end of inbox delivery prep; plugins can filter out profiles from receiving inbox delivery here. Be aware that output can be cached or used several times, so should remain idempotent.
-- $notice Notice
-- &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
-
-StartDefaultLocalNav: When showing the default local nav
-- $menu: the menu
-- $user: current user
-
-EndDefaultLocalNav: When showing the default local nav
-- $menu: the menu
-- $user: current user
-
-StartShowAccountProfileBlock: When showing the profile block for an account
-- $out: XMLOutputter to append custom output
-- $profile: the profile being shown
-
-EndShowAccountProfileBlock: After showing the profile block for an account
-- $out: XMLOutputter to append custom output
-- $profile: the profile being shown
-
-StartShowGroupProfileBlock: When showing the profile block for a group
-- $out: XMLOutputter to append custom output
-- $profile: the profile being shown
-
-EndShowGroupProfileBlock: After showing the profile block for a group
-- $out: XMLOutputter to append custom output
-- $group: the group being shown
-
-StartShowConversation: start the listing of a conversation
-- $action: Action object (used mainly as HTMLOutputter)
-- $conv: Conversation object, has functions to retrieve relevant notices
-- $scoped: Profile for scoping (null if not logged in)
-
-EndShowConversation: after the listing of a conversation
-- $action: Action object (used mainly as HTMLOutputter)
-- $conv: Conversation object, has functions to retrieve relevant notices
-- $scoped: Profile for scoping (null if not logged in)
-
-StartShowThreadedNoticeTail: when showing the replies etc. to a notice
-- $nli: parent noticelistitem
-- $notice: parent notice
-- &$children: list of children
-
-EndShowThreadedNoticeTail: when showing the replies etc. to a notice
-- $nli: parent noticelistitem
-- $notice: parent notice
-- $children: list of children
-
-StartShowThreadedNoticeSub: when showing a reply to a notice
-- $nli: parent noticelistitem
-- $parent: parent notice
-- $child: child notice
-
-EndShowThreadedNoticeSub: when showing a reply to a notice
-- $nli: parent noticelistitem
-- $parent: parent notice
-- $child: child notice
-
-StartAddEmailAddress: when adding an email address through the Web UI
-- $user: user getting the new address
-- $email: email being added
-
-EndAddEmailAddress: done adding an email address through the Web UI
-- $user: user getting the new address
-- $email: email being added
-
-StartValidateEmailInvite: when validating an email address for invitations
-- $user: user doing the invite
-- $email: email address
-- &$valid: flag for if it's valid; can be modified
-
-EndValidateEmailInvite: after validating an email address for invitations
-- $user: user doing the invite
-- $email: email address
-- &$valid: flag for if it's valid; can be modified
-
-StartLocalURL: before resolving a local url for an action
-- &$action: action to find a path for
-- &$paramsi: parameters to pass to the action
-- &$fragment: any url fragement
-- &$addSession: whether to add session variable
-- &$url: resulting URL to local resource
-
-EndLocalURL: before resolving a local url for an action
-- &$action: action to find a path for
-- &$paramsi: parameters to pass to the action
-- &$fragment: any url fragement
-- &$addSession: whether to add session variable
-- &$url: resulting URL to local resource
-
-StartProfileGetAvatar: When getting an avatar for a profile
-- $profile: profile
-- $size: size of the avatar
-- &$avatar: avatar
-
-EndProfileGetAvatar: After getting an avatar for a profile
-- $profile: profile
-- $size: size of the avatar
-- &$avatar: avatar
-
-StartRegisterSuccess: Before showing the registration success message
-- $action: the registration action
-
-StartRegisterSuccess: After showing the registration success message
-- $action: the registration action
-
-StartDocFileForTitle: Before searching for a doc or mail template
-- $title: Title we're looking for
-- &$paths: Paths we're searching
-- &$filename: Filename so far (set this if you want)
-
-EndDocFileForTitle: After searching for a doc or mail template
-- $title: Title we looked for
-- $paths: Paths we searched
-- &$filename: Filename so far (set this if you want)
-
-StartReadWriteTables: when noting which tables must be read-write, even on read-only actions
-- &$tables: list of table names
-- &$rwdb: read-write database URI
-
-EndReadWriteTables: after noting which tables must be read-write, even on read-only actions
-- $tables: list of table names
-- $rwdb: read-write database URI
-
-StartShowInviteForm: Right before displaying the invitations form
-- $action: invitation action
-
-EndShowInviteForm: After displaying the invitations form
-- $action: invitation action
-
-StartSendInvitations: Right before sending invitations
-- $action: invitation action
-
-EndSendInvitations: Right after sending invitations
-- $action: invitation action
-
-StartShowInvitationSuccess: Right before showing invitations success msg
-- $action: invitation action
-
-EndShowInvitationSuccess: After showing invitations success msg
-- $action: invitation action
-
-StartUpgrade: when starting a site upgrade
-
-EndUpgrade: when ending a site upgrade; good place to do your own upgrades
-
-HaveIMPlugin: is there an IM plugin loaded?
-- &$haveIMPlugin: set me to true if you're loaded!
-
-StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div
-- $nli: NoticeListItem being shown
-
-EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div
-- $nli: NoticeListItem being shown
-
-StartNoticeInScope: Before checking if a notice should be visible to a user
-- $notice: The notice to check
-- $profile: The profile to check for scope
-- &$bResult: The boolean result; fill this in if you want to skip
-
-EndNoticeInScope: After checking if a notice should be visible to a user
-- $notice: The notice to check
-- $profile: The profile to check for scope
-- &$bResult: The boolean result; overwrite this if you so desire
-
-StartNoticeListPrefill: Before pre-filling a list of notices with extra data
-- &$notices: Notices to be pre-filled
-- $avatarSize: The avatar size for the list
-
-EndNoticeListPrefill: After pre-filling a list of notices with extra data
-- &$notices: Notices that were pre-filled
-- &$profiles: Profiles that were pre-filled
-- $avatarSize: The avatar size for the list
-
-OtherAccountProfiles: Hook to add account profiles to a user account profile block
-- $profile: the Profile being shown
-- &$others: Modifiable array of profile info arrays. Each one has the following fields:
- href: link to the profile
- text: text for the profile
- image: mini image for the profile
-
-CreateFileImageThumbnailSource: Hook to create image thumbnail source from a File
-- $file: 'File' object to source the image from
-- &$imgPath: Path to image file which can be used as source for our thumbnail algorithm.
-- $media: MIME media type ('image', 'video', 'audio' etc.)
-
-StartResizeImageFile: Hook to resize an image and output it to a file. No matching End event yet.
-- $imagefile: ImageFile object we're resizing.
-- $outpath: string with output filepath
-- $box: array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h').
-
-FillImageFileMetadata: Get more metadata about the ImageFile if it is perhaps not a real local file
-- $imagefile ImageFile object which we're getting metadata for (such as animated status, width/height etc.)
-
-StartShowAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
-- $out: HTMLOutputter class to use for outputting HTML.
-- $file: 'File' object which we're going to show representation for.
-
-EndShowAttachmentRepresentation: Executed after Attachment representation, despite perhaps being unsupported media.
-- $out: HTMLOutputter class to use for outputting HTML.
-- $file: 'File' object which we're going to show representation for.
-
-ShowUnsupportedAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
-- $out: HTMLOutputter class to use for outputting HTML.
-- $file: 'File' object which we're going to show representation for.
-
-StartNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
-- $stored: Notice object that is being distributed.
-- &$mentioned_ids: Array of profile IDs (not just for local users) who got mentioned by the notice.
-
-EndNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
-- $stored: Notice object that is being distributed.
-- $mentioned_ids: Array of profile IDs (not just for local users) who got mentioned by the notice.
-
-StartHomeStubNavItems: Go back Home nav items. Default includes just one item 'home'
-- $out: HTMLOutputter used to output (usually an Action, but not always!)
-- &$items: Referenced array of items in the nav (add if desired)
-
-EndHomeStubNavItems:
-- $out: HTMLOutputter used to output (usually an Action, but not always!)
-- $items: array of menu items
-
-StartSubMenu: Before outputting a submenu (including enclosing tags) to HTML
-- $out: HTMLOutputter used to output (usually an Action, but not always!)
-- $menu: The Menu object outputted as a submenu.
-- $label: Localized text which represents the menu item.
-
-EndSubMenu: After outputting a submenu (including enclosing tags) to HTML
-- $out: HTMLOutputter used to output (usually an Action, but not always!)
-- $menu: The Menu object outputted as a submenu.
-- $label: Localized text which represents the menu item.
-
-StartDocNav: Before outputting the docs Nav
-- $nav: The DoclNav widget
-
-EndDocNav: After outputting the docs Nav
-- $nav: The DoclNav widget
* After installation
- Backups
- Upgrading
+* Additional configuration
Prerequisites
=============
Upgrading is strongly recommended to stay up to date with security fixes
and new features. For instructions on how to upgrade GNU social code,
please see the UPGRADE file.
+
+Additional configuration
+------------------------
+
+Please refer to DOCUMENTATION/SYSTEM_ADMINISTRATORS/CONFIGURE for information.
+++ /dev/null
-Plugins
-=======
-
-GNU social supports 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 AddMyWebsiteLink($action)
-{
-$action->menuItem('http://mywebsite.net/', _('My web site'), _('Example web link'));
-return true;
-}
-
-Event::addHandler('EndPrimaryNav', 'AddMyWebsiteLink');
-
-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 GNU social) 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.
+++ /dev/null
-Things to be done
-=================
-
-* Create a theme for GNU social
-
-* Create a set of plugins to give StatusNet a more social-network UI
-
-* Work on improvements for annoying things in StatusNet (ie. no
- redirect to login page when you need to be logged in, etc)
-
-* Work on adding further Activities, such as sharing photos/video,
- events, UI for managing relationships.
\ No newline at end of file
+++ /dev/null
-Upgrading
-=========
-
-GNU social 1.1.x to GNU social 1.2.x
-------------------------------------
-
-If you are tracking the GNU social git repository, we currently recommend
-using the "master" branch (or nightly if you want to use latest features)
-and follow this procedure:
-
-0. Backup your data. The StatusNet upgrade discussions below have some
- guidelines to back up the database and files (mysqldump and rsync).
-
- MAKE SURE YOU ARE THE SAME USER THAT RUNS THE PHP FILES WHILE PERFORMING
- THE COMMANDS BELOW (I usually prepend the commands with 'sudo -u social')
-
-1. Stop your queue daemons (you can run this command even if you do not
- use the queue daemons):
- $ bash scripts/stopdaemons.sh
-
-2. Run the command to fetch the latest sourcecode:
- $ git pull
-
- If you are not using git we recommend following the instructions below
- for upgrading "StatusNet 1.1.x to GNU social 1.2.x" as they are similar.
-
-3. Run the upgrade script:
- $ php scripts/upgrade.php
-
- The upgrade script will likely take a long time because it will
- upgrade the tables to another character encoding and make other
- automated upgrades. Make sure it ends without errors. If you get
- errors, create a new task on https://git.gnu.io/gnu/gnu-social/issues
-
-4. Start your queue daemons again (you can run this command even if you
- do not use the queue daemons):
- $ bash scripts/startdaemons.sh
-
-5. Report any issues at https://git.gnu.io/gnu/gnu-social/issues
-
-If you are using ssh keys to log in to your server, you can make this
-procedure pretty painless (assuming you have automated backups already).
-Make sure you "cd" into the correct directory (in this case "htdocs")
-and use the correct login@hostname combo:
- $ ssh social@domain.example 'cd htdocs
- && bash scripts/stopdaemons.sh
- && git pull
- && time php scripts/upgrade.php
- && bash scripts/startdaemons.sh'
-
-StatusNet 1.1.x to GNU social 1.2.x
------------------------------------
-
-We cannot support migrating from any other version of StatusNet than
-1.1.1. If you are running a StatusNet version lower than this, please
-follow the upgrade procedures for each respective StatusNet version.
-
-You are now running StatusNet 1.1.1 and want to migrate to GNU social
-1.2.x. Beware there may be changes in minimum required version of PHP
-and the modules required, so review the INSTALL file (php5-intl is a
-newly added dependency for example).
-
-* Before you begin: Make backups. Always make backups. Of your entire
-directory structure and the database too. All tables. All data. Alles.
-
-0. Make a backup of everything. To backup the database, you can use a
-variant of this command (you will be prompted for the database password):
- $ mysqldump -u dbuser -p dbname > social-backup.sql
-
-1. Stop your queue daemons 'bash scripts/stopdaemons.sh' should do it.
- Not everyone runs queue daemons, but the above command won't hurt.
-
-2. Unpack your GNU social code to a fresh directory. You can do this
- by cloning our git repository:
- $ git clone https://git.gnu.io/gnu/gnu-social.git gnusocial
-
-3. Synchronize your local files to the GNU social directory. These
- will be the local files such as avatars, config and files:
-
- avatar/*
- file/*
- local/*
- .htaccess
- config.php
-
- This command will point you in the right direction on how to do it:
- $ rsync -avP statusnet/{.htaccess,avatar,file,local,config.php} gnusocial/
-
-4. Replace your old StatusNet directory with the new GNU social
- directory in your webserver root.
-
-5. Run the upgrade script: 'php scripts/upgrade.php'
- The upgrade script will likely take a long time because it will
- upgrade the tables to another character encoding and make other
- automated upgrades. Make sure it ends without errors. If you get
- errors, create a new task on https://git.gnu.io/gnu/gnu-social/issues
-
-6. Start your queue daemons: 'bash scripts/startdaemons.sh'
-
-7. Report any issues at https://git.gnu.io/gnu/gnu-social/issues
+++ /dev/null
-### GNU social "fancy URL" setup
-#
-# Change the "RewriteBase" in the new .htaccess file to be the URL path
-# to your GNU Social installation on your server. Typically this will
-# be the path to your GNU Social directory relative to your Web root.
-# If you are installing it in the root directory, leave it as '/'.
-#
-# If it doesn't work, double-check that AllowOverride for the GNU Social
-# directory is 'All' in your Apache configuration file. This can be
-# * /etc/apache2/apache2.conf (generic)
-# * /etc/apache2/sites-available/default(on Debian and Ubuntu)
-# * ...many other variations depending on distribution...
-#
-# See the Apache documentation for .htaccess files for more details:
-# https://httpd.apache.org/docs/2.4/howto/htaccess.html
-#
-# Also, check that mod_rewrite is installed and enabled:
-# https://httpd.apache.org/docs/2.4/mod/mod_rewrite.html
-
-
-<IfModule mod_rewrite.c>
- RewriteEngine On
-
- # NOTE: change this to your actual GNU social base URL path,
- # minus the domain part:
- #
- # https://social.example.com/ => /
- # https://example.com/social/ => /social/
- #
- RewriteBase /
- #RewriteBase /mublog/
-
- ## Uncomment these if having trouble with API authentication
- ## when PHP is running in CGI or FastCGI mode.
- #
- #RewriteCond %{HTTP:Authorization} ^(.*)
- #RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1]
-
- RewriteCond %{REQUEST_FILENAME} !-f
- RewriteCond %{REQUEST_FILENAME} !-d
- RewriteRule (.*) index.php?p=$1 [L,QSA]
-
- ## You can also use PATHINFO by using this RewriteRule instead:
- # RewriteRule (.*) index.php/$1 [L,QSA]
-</IfModule>
-
-<FilesMatch "\.(ini)">
- <IfVersion < 2.3>
- Order allow,deny
- Deny from all
- </IfVersion>
- <IfVersion >= 2.3>
- Require all denied
- </IfVersion>
-</FilesMatch>
+++ /dev/null
-# This is completely optional, but if you're running a site with
-# ssl="always" configured, then you might as well redirect any of
-# your stray HTTP visitors to HTTPS.
-#
-#$HTTP["scheme"] == "http" {
-# $HTTP["host"] =~ "^(social\.example\.com)$" {
-# url.redirect = ( "^\/?(.*)" => "https://%1/$1" )
-# server.name = "%1"
-# }
-#}
-
-# If you're using vhosts, you should have per-vhost server.document-root
-# settings too! Read how in the respective alternative vhost modules.
-#$HTTP["host"] =~ "^social\.example\.com$" {
-
-# NOTE: configure fastcgi/cgi/fpm here if you're using per-user cgi/fpm
-# fastcgi.server += ( ".php" =>
-# ( "localhost" => (
-# "host" => "127.0.0.1",
-# "port" => "9000"
-# ))
-# )
-
- dir-listing.activate = "disable"
-
-# Make sure "mod_rewrite" is enabled in server.modules
- url.rewrite-if-not-file = ( "^/(.*)$" => "/index.php/$1" )
-#}
+++ /dev/null
-server {
- listen [::]:80;
- listen 80;
-
-# FIXME: Change domain name here (and also make sure you do the same in the next 'server' section)
- server_name social.example.org;
-
-# redirect all traffic to HTTPS
- rewrite ^ https://$host$request_uri? permanent;
-}
-
-server {
-# HTTPS is mandatory on GNU social unless you are using Tor network. Seriously.
-# Set it up with a cert (any cert) before you run the install.
- listen [::]:443 ssl http2;
- listen 443 ssl http2;
-
-# Root
-# FIXME: Change the path below to where you installed GNU social
- root /path/to/gnusocial/root;
-
-# Server name
-# FIXME: Change "social.example.org" to your site's domain name
-# GNU social MUST be installed in the domain root
- server_name social.example.org;
-
-# SSL
-# FIXME: Change the paths to setup your SSL key/cert. See https://cipherli.st/ for more information
- ssl_certificate ssl/certs/social.example.org.crt;
- ssl_certificate_key ssl/private/social.example.org.key;
-
-# Index
- index index.php;
-
-# PHP
- location ^~ /index.php {
- include fastcgi_params;
- include snippets/fastcgi-php.conf;
-
- fastcgi_pass unix:/var/run/php/php-fpm.sock;
- fastcgi_param SCRIPT_FILENAME $request_filename;
- }
-
-# Don't allow any PHP file other than index.php to be executed
-# This will ensure that nor config.php nor plugin files with eventual hardcoded security information are downloadable
-# And this is better than allowing php files to be executed in case of forgotten `if (!defined('GNUSOCIAL')) { exit(1); }`
- location ~ \.php$ {
- deny all;
- }
-
-# Location
- location / {
- try_files $uri $uri/ @index_handler;
- }
-
-# Fancy URLs
- error_page 404 @index_handler;
- location @index_handler {
- rewrite ^(.*)$ /index.php?p=$1 last;
- }
-
-# Restrict access that is unnecessary anyway
- location ~ /\.(ht|git) {
- deny all;
- }
-
-#
-# Hardening (optional)
-#
-# add_header Strict-Transport-Security "max-age=15768000; preload;";
-# add_header X-Content-Type-Options nosniff;
-# add_header Referrer-Policy strict-origin-when-cross-origin;
-# add_header Content-Security-Policy "default-src 'self' 'unsafe-inline'; frame-ancestors 'self'; form-action 'self'; style-src 'self' 'unsafe-inline'; img-src * blob: data:;";
-# add_header X-Permitted-Cross-Domain-Policies none;
-# add_header X-Robots-Tag all; # Not really hardening, just here for strictness purposes
-#
-# client_max_body_size 15M;
-# client_body_buffer_size 128k;
-# gzip_vary on;
-#
-# location ~* \.(?:css|js|woff|svg|gif|png|webp|ttf|ico|jpe?g)$ {
-# gzip on;
-# gzip_comp_level 4;
-# add_header Cache-Control "public";
-# expires 30d;
-# access_log off;
-# log_not_found off;
-# }
-}
Additional information on using and developing plugins can be found
at the following locations:
-* [Plugin Development](doc/Plugin_development.md)
+* [Plugin Development](../DOCUMENTATION/DEVELOPERS/Plugins/README.md)
* [Community Plugins](https://git.gnu.io/gnu/gnu-social/wikis/GNU-Social-Community-Plugins)
+++ /dev/null
-Plugin Development
-=======================
-
-SamplePlugin.php
------------------------
-
-Each plugin requires a main class to interact with the GNU social system.
-
-The main class usually extends the Plugin class that comes with GNU social.
-
-The class has standard-named methods that will be called when certain events
-happen in the code base. These methods have names like 'onX' where X is an
-event name (see EVENTS.txt for the list of available events). Event handlers
-have pre-defined arguments, based on which event they're handling. A typical
-event handler:
-
-```php
-function onSomeEvent($paramA, &$paramB)
-{
- if ($paramA == 'jed') {
- throw new Exception(sprintf(_m("Invalid parameter %s"), $paramA));
- }
- $paramB = 'spock';
- return true;
-}
-```
-
-Event Handlers
------------------------
-
-Event handlers must return a Boolean value.
-
-If they return false, all other event handlers for this event (in other plug-in)
-will be skipped, and in some cases the default processing for that event would
-be skipped. This is great for replacing the default action of an event.
-
-If the handler returns true, processing of other event handlers and the default
-processing will continue. This is great for extending existing functionality.
-
-If the handler throws an exception, processing will stop, and the exception's
-error will be shown to the user.
-
-Installation
-------------------
-
-To install a plugin (like this one), site admins add the following code to their
-config.php file:
-
-```php
-addPlugin('Sample');
-```
-
-Plugins must be installed in one of the following directories:
-
-* local/plugins/{$pluginclass}.php
-* local/plugins/{$name}/{$pluginclass}.php
-* local/{$pluginclass}.php
-* local/{$name}/{$pluginclass}.php
-* plugins/{$pluginclass}.php
-* plugins/{$name}/{$pluginclass}.php
-
-Here, `{$name}` is the name of the plugin, like 'Sample', and `{$pluginclass}`
-is the name of the main class, like 'SamplePlugin'. Plugins that are part of
-the main GNU social distribution go in 'plugins' and third-party or local ones
-go in 'local'.
-
-Simple plugins can be implemented as a single module. Others are more complex
-and require additional modules; these should use their own directory, like
-'local/plugins/{$name}/'. All files related to the plugin, including images,
-JavaScript, CSS, external libraries or PHP modules should go in the plugin
-directory.
-
-Plugin Configuration
-------------------
-
-Plugins are configured using public instance attributes. To set their values,
-site administrators use this syntax:
-
-```php
-addPlugin('Sample', ('attr1' => 'foo', 'attr2' => 'bar'));
-```
-
-The same plugin class can be initialized multiple times with different arguments:
-
-```php
-addPlugin('EmailNotify', array('sendTo' => 'evan@status.net'));
-addPlugin('EmailNotify', array('sendTo' => 'brionv@status.net'));
-```
-
-```php
-class SamplePlugin extends Plugin
-{
- public $attr1 = null;
- public $attr2 = null;
-}
-```
-
-Initialization
-------------------
-
-Plugins overload this method to do any initialization they need, like connecting
-to remote servers or creating paths or so on. @return boolean hook value; true
-means continue processing, false means stop.
-
-```php
-function initialize()
-{
- return true;
-}
-```
-
-Clean Up
-------------------
-
-Plugins overload this method to do any cleanup they need, like disconnecting from
-remote servers or deleting temp files or so on.
-
-```php
-function cleanup()
-{
- return true;
-}
-```
-
-Database schema setup
-------------------
-
-Plugins can add their own tables to the GNU social database. Plugins should use
-GNU social's schema interface to add or delete tables. The ensureTable() method
-provides an easy way to ensure a table's structure and availability.
-
-By default, the schema is checked every time GNU social is run (say, when a Web
-page is hit). Admins can configure their systems to only check the schema when
-the checkschema.php script is run, greatly improving performance. However, they
-need to remember to run that script after installing or upgrading a plugin!
-
-```php
-function onCheckSchema()
-{
- $schema = Schema::get();
-
- // '''For storing user-submitted flags on profiles'''
-
- $schema->ensureTable('user_greeting_count',
- array(new ColumnDef('user_id', 'integer', null,
- true, 'PRI'),
- new ColumnDef('greeting_count', 'integer')));
-
- return true;
-}
-```
-
-Load related modules when needed
-------------------
-
-Most non-trivial plugins will require extra modules to do their work. Typically
-these include data classes, action classes, widget classes, or external libraries.
-
-This method receives a class name and loads the PHP file related to that class.
-By tradition, action classes typically have files named for the action, all
-lower-case. Data classes are in files with the data class name, initial letter
-capitalized.
-
-Note that this method will be called for *all* overloaded classes, not just ones
-in this plugin! So, make sure to return true by default to let other plugins,
-and the core code, get a chance.
-
-```php
-function onAutoload($cls)
-{
- $dir = dirname(__FILE__);
-
- switch ($cls)
- {
- case 'HelloAction':
- include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
- return false;
- case 'User_greeting_count':
- include_once $dir . '/'.$cls.'.php';
- return false;
- default:
- return true;
- }
-}
-```
-
-Map URLs to actions
-------------------
-
-This event handler lets the plugin map URLs on the site to actions (and thus an
-action handler class). Note that the action handler class for an action will be
-named 'FoobarAction', where action = 'foobar'. The class must be loaded in the
-onAutoload() method.
-
-```php
-function onRouterInitialized($m)
-{
- $m->connect('main/hello',
- array('action' => 'hello'));
- return true;
-}
-```
-
-Modify the default menu to link to our custom action
-------------------
-
-Using event handlers, it's possible to modify the default UI for pages almost
-without limit. In this method, we add a menu item to the default primary menu
-for the interface to link to our action.
-
-Action Class
-------------------
-
-The Action class provides a rich set of events to hook, as well as output methods.
-
-```php
-function onEndPrimaryNav($action)
-{
- // '''common_local_url()''' gets the correct URL for the action name we provide
-
- $action->menuItem(common_local_url('hello'),
- _m('Hello'), _m('A warm greeting'), false, 'nav_hello');
- return true;
-}
-
-function onPluginVersion(&$versions)
-{
- $versions[] = array('name' => 'Sample',
- 'version' => STATUSNET_VERSION,
- 'author' => 'Brion Vibber, Evan Prodromou',
- 'homepage' => 'http://example.org/plugin',
- 'rawdescription' =>
- _m('A sample plugin to show basics of development for new hackers.'));
- return true;
-}
-```
-
-hello.php
-------------------
-
-This section is taken directly from the 'hello.php'. ( plugins/Sample/hello.php )
-
-Give a warm greeting to our friendly user.
-
-This sample action shows some basic ways of doing output in an action class.
-
-Action classes have several output methods that they override from the parent class.
-
-```php
-class HelloAction extends Action
-{
- var $user = null;
- var $gc = null;
-}
-```
-
-Take arguments for running
-------------------
-
-This method is called first, and it lets the action class get all its arguments
-and validate them. It's also the time to fetch any relevant data from the database.
-
-Action classes should run parent::prepare(array $args = []) as the first line
-of this method to make sure the default argument-processing happens.
-
-```php
-function prepare(array $args = [])
-{
- parent::prepare($args);
-
- $this->user = common_current_user();
-
- if (!empty($this->user)) {
- $this->gc = User_greeting_count::inc($this->user->id);
- }
-
- return true;
-}
-```
-
-Handle request
-------------------
-
-This is the main method for handling a request. Note that most preparation
-should be done in the prepare() method; by the time handle() is called the
-action should be more or less ready to go.
-
-```php
-function handle()
-{
- parent::handle();
-
- $this->showPage();
-}
-```
-
-Title of this page
-------------------
-
-Override this method to show a custom title.
-
-```php
-function title()
-{
- if (empty($this->user)) {
- return _m('Hello');
- } else {
- return sprintf(_m('Hello, %s'), $this->user->nickname);
- }
-}
-```
-
-Show content in the content area
-------------------
-
-The default GNU social page has a lot of decorations: menus, logos, tabs, all
-that jazz. This method is used to show content in the content area of the
-page; it's the main thing you want to overload. This method also demonstrates
-use of a plural localized string.
-
-```php
-function showContent()
-{
- if (empty($this->user)) {
- $this->element('p', array('class' => 'greeting'),
- _m('Hello, stranger!'));
- } else {
- $this->element('p', array('class' => 'greeting'),
- sprintf(_m('Hello, %s'), $this->user->nickname));
- $this->element('p', array('class' => 'greeting_count'),
- sprintf(_m('I have greeted you %d time.',
- 'I have greeted you %d times.',
- $this->gc->greeting_count),
- $this->gc->greeting_count));
- }
-}
-```
-
-Return true if read only.
-------------------
-
-Some actions only read from the database; others read and write. The simple
-database load-balancer built into GNU social will direct read-only actions to
-database mirrors (if they are configured) and read-write actions to the master database.
-
-This defaults to false to avoid data integrity issues, but you should make sure
-to overload it for performance gains.
-
-```php
-function isReadOnly($args)
-{
- return false;
-}
-```
-
+++ /dev/null
-Initial simple way to Webfinger enable your domain -- needs PHP.
-================================================================
-
-This guide needs some updating, since it will only guide you to present
-XML data (while the curl command likely gives you JSON). The workaround
-is to simply make curl get 'webfinger.xml' instead, and/or have another
-file that contains JSON, but that requires editing the PHP file as well.
-
-Step 1
-======
-
-Put the 'dot-well-known' on your website, so it loads at:
-
- https://example.com/.well-known/
-
-(Remember the . at the beginning of this one, which is common practice
-for "hidden" files and why we have renamed it "dot-")
-
-Step 2
-======
-
-Edit the .well-known/host-meta file and replace "example.com" with the
-domain name you're hosting the .well-known directory on.
-
-Using vim you can do this as a quick method:
- $ vim .well-known/host-meta [ENTER]
- :%s/example.com/domain.com/ [ENTER]
- :wq [ENTER]
-
-Step 3
-======
-
-For each user on your site, and this might only be you...
-
-In the webfinger directory, make a copy of the example@example.com.xml file
-so that it's called (replace username and example.com with appropriate
-values, the domain name should be the same as you're "socialifying"):
-
- username@example.com.xml
-
-Then edit the file contents, replacing "social.example.com" with your
-GNU social instance's base path, and change the user ID number (and
-nickname for the FOAF link) to that of your account on your social
-site. If you don't know your user ID number, you can see this on your
-GNU social profile page by looking at the destination URLs in the
-Feeds links.
-
-PROTIP: You can get the bulk of the contents (note the <Subject> element though)
- from curling down your real webfinger data:
-$ curl https://social.example.com/.well-known/webfinger?resource=acct:username@social.example.com
-
-Finally
-=======
-
-Using this method, though fiddly, you can now be @user@domain without
-the need for any prefixes for subdomains, etc.
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>
-<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0" xmlns:hm="http://host-meta.net/xrd/1.0">
- <Link rel="lrdd" type="application/xrd+xml"
- template="https://example.com/.well-known/webfinger?resource={uri}"/>
-</XRD>
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>
-<XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
- <Subject>acct:username@example.com</Subject>
- <Alias>acct:username@social.example.com</Alias>
- <Alias>https://social.example.com/user/1</Alias>
- <Link rel="http://webfinger.net/rel/profile-page"
- type="text/html"
- href="https://social.example.com/user/1"/>
-
- <Link rel="http://schemas.google.com/g/2010#updates-from"
- type="application/atom+xml"
- href="https://social.example.com/api/statuses/user_timeline/1.atom"/>
-
- <!-- Is this/was this ever supported?
- <Link rel="http://microformats.org/profile/hcard"
- type="text/html"
- href="https://social.example.com/hcard"/> -->
-
- <Link rel="http://gmpg.org/xfn/11"
- type="text/html"
- href="https://social.example.com/user/1"/>
-
- <Link rel="describedby"
- type="application/rdf+xml"
- href="https://social.example.com/username/foaf"/>
-
- <Link rel="http://salmon-protocol.org/ns/salmon-replies"
- href="https://social.example.com/main/salmon/user/1"/>
-
- <Link rel="http://salmon-protocol.org/ns/salmon-mention"
- href="https://social.example.com/main/salmon/user/1"/>
-
- <Link rel="http://ostatus.org/schema/1.0/subscribe"
- template="https://social.example.com/main/ostatussub?profile={uri}"/>
-</XRD>
+++ /dev/null
-<?php
-
-/*
- * GNU social
- * Copyright (C) 2010, Free Software Foundation, Inc
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-
-
-// basename should make sure we can't escape this directory
-$u = basename($_GET['resource']);
-
-if (!strpos($u, '@')) {
- throw new Exception('Bad resource');
- exit(1);
-}
-
-if (mb_strpos($u, 'acct:')===0) {
- $u = substr($u, 5);
-}
-
-// Just to be a little bit safer, you know, with all the unicode stuff going on
-$u = filter_var($u, FILTER_SANITIZE_EMAIL);
-
-$f = $u . ".xml";
-
-if (file_exists($f)) {
- header('Content-Disposition: attachment; filename="'.urlencode($f).'"');
- header('Content-type: application/xrd+xml');
- echo file_get_contents($f);
-}
projects / quix0rs-gnu-social.git / commitdiff