Merge branch '0.8.x' of git://gitorious.org/laconica/dev into dev/0.8.x

1 files changed, 176 insertions, 116 deletions

diff --git a/README b/README
index 2c9ae84d9..4f9382960 100644
--- a/README
+++ b/README
@@ -2,8 +2,8 @@
 README
 ------
 
-Laconica 0.7.1 ("West of the Fields")
-6 February 2009
+Laconica 0.7.3 ("You Are The Everything")
+7 April 2009
 
 This is the README file for Laconica, the Open Source microblogging
 platform. It includes installation instructions, descriptions of
@@ -71,54 +71,29 @@ for additional terms.
 New this version
 ================
 
-This is a minor bug-fix release since version 0.7.0, released Jan 29
-2009. Notable changes this version:
-
-- Vast improvement in auto-linking to URLs.
-- Link to group search from user's group page
-- Improved interface in Facebook application
-- Fix bad redirects in delete notice
-- Updated PostgreSQL database creation script
-- Show filesize in avatar/logo upload
-- Vastly improved avatar/logo upload
-- Allow re-authentication with OpenID
-- Correctly link hashtabs inside parens and brackets
-- Group and avatar image transparency works
-- Better handling of commands through the Web and Ajax channels
-- Fix links for profile page feeds
-- Fixed destroy method in API
-- Fix endpoint of Connect menu when XMPP disabled
-- Show number of group members
-- Enable configuration files in /etc/laconica/
-
-Changes in version 0.7.0:
-
-- Support for groups. Users can join groups and send themed notices
-  to those groups. All other members of the group receive the notices.
-- Laconica-specific extensions to the Twitter API.
-- A Facebook application.
-- A massive UI redesign. The HTML generated by Laconica has changed
-  significantly, to make theming easier and to give a more open look
-  by default. Also, sidebar.
-- Massive code hygiene changes to move towards compliance with the PEAR
-  coding standards and to support the new UI redesign.
-- Began the breakup of util.php -- moved about 30% of code to a views
-  hierarchy.
-- UI elements for statistical information (like top posters or most
-  popular groups) added in a sidebar.
-- include Javascript badge by Kent Brewster.
-- Updated online documentation.
-- Cropping of user avatars using Jcrop.
-- fix for Twitter bridge to not send "Expect:" headers.
-- add 'dm' as a synonym for 'd' in commands.
-- Upgrade upstream version of jQuery to 1.3.
-- Upgrade upstream version of PHP-OpenID to 2.1.2.
-- Move OpenMicroBlogging specification to its own repository.
-- Make tag-based RSS streams work.
-- Additional locales: Bulgarian, Catalan, Greek, Hebrew, simplified
-  Chinese, Telugu, Taiwanese Chinese, Vietnamese,
-- PostgreSQL updates.
-- Nasty bug in Twitter bridge that wouldn't verify with Twitter
+This is a minor bug-fix and feature release since version 0.7.2.1,
+released Mar 11 2009. Notable changes this version:
+
+- A plugin to allow a templating language for customization
+- A plugin for Piwik Analytics engine
+- A bookmarklet for posting a notice about a Web page you're reading
+- A welcome notice ('welcomebot') and default subscription for new users
+- Support for SSL for some or all pages on the site
+- Better handling of empty notice lists on many pages
+- Major improvements to the Twitter friend-sync offline processing
+- subscribers, subscriptions, groups are listed on the Personal page.
+- "Invite" link restored to main menu
+- Better memory handling in FOAF output
+- Fix for SUP support (FriendFeed)
+- Correct and intelligent redirect HTTP status codes
+- Fix DB collations for search and sort
+- Better H1s and Titles using user full names
+- Fixes to make the linkback plugin operational
+- Better indication that a notice is being published by Ajax (spinner)
+- Better and unified Atom output
+- Hiding "register" and "join now" messages when site is closed
+- ping, twitter and facebook queuehandlers working better
+- Updated RPM spec
 
 Prerequisites
 =============
@@ -222,9 +197,9 @@ especially if you've previously installed PHP/MySQL packages.
 1. Unpack the tarball you downloaded on your Web server. Usually a
    command like this will work:
 
-   	   tar zxf laconica-0.7.1.tar.gz
+   	   tar zxf laconica-0.7.3.tar.gz
 
-   ...which will make a laconica-0.7.1 subdirectory in your current
+   ...which will make a laconica-0.7.3 subdirectory in your current
    directory. (If you don't have shell access on your Web server, you
    may have to unpack the tarball on your local computer and FTP the
    files to the server.)
@@ -232,7 +207,7 @@ especially if you've previously installed PHP/MySQL packages.
 2. Move the tarball to a directory of your choosing in your Web root
    directory. Usually something like this will work:
 
-   	   mv laconica-0.7.1 /var/www/mublog
+   	   mv laconica-0.7.3 /var/www/mublog
 
    This will make your Laconica instance available in the mublog path of
    your server, like "http://example.net/mublog". "microblog" or
@@ -240,21 +215,28 @@ especially if you've previously installed PHP/MySQL packages.
    configure virtual hosts on your web server, you can try setting up
    "http://micro.example.net/" or the like.
 
-3. You should also take this moment to make your avatar subdirectory
-   writeable by the Web server. An insecure way to do this is:
+3. Make your target directory writeable by the Web server.
 
-   	  chmod a+w /var/www/mublog/avatar
+   	  chmod a+w /var/www/mublog/
 
    On some systems, this will probably work:
 
-      	   chgrp www-data /var/www/mublog/avatar
-	   chmod g+w /var/www/mublog/avatar
+      	   chgrp www-data /var/www/mublog/
+	   chmod g+w /var/www/mublog/
 
    If your Web server runs as another user besides "www-data", try
    that user's default group instead. As a last resort, you can create
-   a new group like "avatar" and add the Web server's user to the group.
+   a new group like "mublog" and add the Web server's user to the group.
+
+4. You should also take this moment to make your avatar subdirectory
+   writeable by the Web server. An insecure way to do this is:
+
+   	  chmod a+w /var/www/mublog/avatar
+
+   You can also make the avatar directory writeable by the Web server
+   group, as noted above.
 
-4. Create a database to hold your microblog data. Something like this
+5. Create a database to hold your microblog data. Something like this
    should work:
 
    	  mysqladmin -u "username" --password="password" create laconica
@@ -267,63 +249,55 @@ especially if you've previously installed PHP/MySQL packages.
    a tool like PHPAdmin to create a database. Check your hosting
    service's documentation for how to create a new MySQL database.)
 
-5. Run the laconica.sql SQL script in the db subdirectory to create
-   the database tables in the database. A typical system would work
-   like this:
-
-   	  mysql -u "username" --password="password" laconica < /var/www/mublog/db/laconica.sql
-
-   You may want to test by logging into the database and checking that
-   the tables were created. Here's an example:
-
-          SHOW TABLES;
-
 6. Create a new database account that Laconica will use to access the
    database. If you have shell access, this will probably work from the
    MySQL shell:
 
-          GRANT SELECT,INSERT,DELETE,UPDATE on laconica.*
+          GRANT ALL on laconica.*
 	  TO 'lacuser'@'localhost'
 	  IDENTIFIED BY 'lacpassword';
 
    You should change 'lacuser' and 'lacpassword' to your preferred new
-   username and password. You may want to test logging in as this new
-   user and testing that you can SELECT from some of the tables in the
-   DB (use SHOW TABLES to see which ones are there).
-
-7. Copy the config.php.sample in the Laconica directory to config.php.
-
-8. Edit config.php to set the basic configuration for your system.
-   (See descriptions below for basic config options.) Note that there
-   are lots of options and if you try to do them all at once, you will
-   have a hard time making sure what's working and what's not. So,
-   stick with the basics at first. In particular, customizing the
-   'site' and 'db' settings will almost definitely be needed.
-
-9. At this point, you should be able to navigate in a browser to your
-   microblog's main directory and see the "Public Timeline", which
-   will be empty. If not, magic has happened! You can now register a
-   new user, post some notices, edit your profile, etc. However, you
-   may want to wait to do that stuff if you think you can set up
-   "fancy URLs" (see below), since some URLs are stored in the database.
+   username and password. You may want to test logging in to MySQL as
+   this new user.
+
+7. In a browser, navigate to the Laconica install script; something like:
+
+           http://yourserver.example.com/mublog/install.php
+
+   Enter the database connection information and your site name. The
+   install program will configure your site and install the initial,
+   almost-empty database.
+
+8. You should now be able to navigate to your microblog's main directory
+   and see the "Public Timeline", which will be empty. If not, magic
+   has happened! You can now register a new user, post some notices,
+   edit your profile, etc. However, you may want to wait to do that stuff
+   if you think you can set up "fancy URLs" (see below), since some
+   URLs are stored in the database.
 
 Fancy URLs
 ----------
 
-By default, Laconica will have big long sloppy URLs that are hard for
-people to remember or use. For example, a user's home profile might be
+By default, Laconica will use URLs that include the main PHP program's
+name in them. For example, a user's home profile might be
 found at:
 
-    http://example.org/mublog/index.php?action=showstream&nickname=fred
+    http://example.org/mublog/index.php/mublog/fred
+
+On certain systems that don't support this kind of syntax, they'll
+look like this:
+
+    http://example.org/mublog/index.php?p=mublog/fred
 
 It's possible to configure the software so it looks like this instead:
 
     http://example.org/mublog/fred
 
 These "fancy URLs" are more readable and memorable for users. To use
-fancy URLs, you must either have Apache 2.2.x with .htaccess enabled
-and mod_redirect enabled, -OR- know how to configure "url redirection"
-in your server.
+fancy URLs, you must either have Apache 2.x with .htaccess enabled and
+mod_redirect enabled, -OR- know how to configure "url redirection" in
+your server.
 
 1. Copy the htaccess.sample file to .htaccess in your Laconica
    directory. Note: if you have control of your server's httpd.conf or
@@ -348,10 +322,6 @@ like:
 If you changed your HTTP server configuration, you may need to restart
 the server first.
 
-If you have problems with the .htaccess file on versions of Apache
-earlier than 2.2.x, try changing the regular expressions in the
-htaccess.sample file that use "\w" to just use ".".
-
 Sphinx
 ------
 
@@ -511,7 +481,7 @@ server is probably a good idea for high-volume sites.
    needs as a parameter the install path; if you run it from the
    Laconica dir, "." should suffice.
 
-This will run six (for now) queue handlers:
+This will run eight (for now) queue handlers:
 
 * xmppdaemon.php - listens for new XMPP messages from users and stores
   them as notices in the database.
@@ -525,6 +495,10 @@ This will run six (for now) queue handlers:
   of registered users.
 * xmppconfirmhandler.php - sends confirmation messages to registered
   users.
+* twitterqueuehandler.php - sends queued notices to Twitter for user
+  who have opted to set up Twitter bridging.
+* facebookqueuehandler.php - sends queued notices to Facebook for users
+  of the built-in Facebook application.
 
 Note that these queue daemons are pretty raw, and need your care. In
 particular, they leak memory, and you may want to restart them on a
@@ -557,6 +531,53 @@ Sample cron job:
 # Update Twitter friends subscriptions every half hour
 0,30 * * * * /path/to/php /path/to/laconica/scripts/synctwitterfriends.php>&/dev/null
 
+Built-in Facebook Application
+-----------------------------
+
+Laconica's Facebook application allows your users to automatically
+update their Facebook statuses with their latest notices, invite
+their friends to use the app (and thus your site), view their notice
+timelines, and post notices -- all from within Facebook. The application
+is built into Laconica and runs on your host.  For automatic Facebook
+status updating to work you will need to enable queuing and run the
+facebookqueuehandler.php daemon (see the "Queues and daemons" section
+above).
+
+Quick setup instructions*:
+
+Install the Facebook Developer application on Facebook:
+
+    http://www.facebook.com/developers/
+
+Use it to create a new application and generate an API key and secret.
+Uncomment the Facebook app section of your config.php and copy in the
+key and secret, e.g.:
+
+    # Config section for the built-in Facebook application
+    $config['facebook']['apikey'] = 'APIKEY';
+    $config['facebook']['secret'] = 'SECRET';
+
+In Facebook's application editor, specify the following URLs for your app:
+
+- Callback URL: http://example.net/mublog/facebook/
+- Post-Remove URL: http://example.net/mublog/facebook/remove
+- Post-Add Redirect URL: http://apps.facebook.com/yourapp/
+- Canvas URL: http://apps.facebook.com/yourapp/
+
+(Replace 'example.net' with your host's URL, 'mublog' with the path
+to your Laconica installation, and 'yourapp' with the name of the
+Facebook application you created.)
+
+Additionally, Choose "Web" for Application type in the Advanced tab.
+In the "Canvas setting" section, choose the "FBML" for Render Method,
+"Smart Size" for IFrame size, and "Full width (760px)" for Canvas Width.
+Everything else can be left with default values.
+
+*For more detailed instructions please see the installation guide on the
+Laconica wiki:
+
+    http://laconi.ca/trac/wiki/FacebookApplication
+
 Sitemaps
 --------
 
@@ -597,7 +618,7 @@ to these resources.
 Themes
 ------
 
-There are two themes shipped with this version of Laconica: "stoica",
+There are two themes shipped with this version of Laconica: "identica",
 which is what the Identi.ca site uses, and "default", which is a good
 basis for other sites.
 
@@ -676,7 +697,7 @@ Upgrading
 If you've been using Laconica 0.6, 0.5 or lower, or if you've been
 tracking the "git" version of the software, you will probably want
 to upgrade and keep your existing data. There is no automated upgrade
-procedure in Laconica 0.7.1. Try these step-by-step instructions; read
+procedure in Laconica 0.7.3. Try these step-by-step instructions; read
 to the end first before trying them.
 
 0. Download Laconica and set up all the prerequisites as if you were
@@ -703,16 +724,19 @@ to the end first before trying them.
    directory to your new directory.
 9. Copy htaccess.sample to .htaccess in the new directory. Change the
    RewriteBase to use the correct path.
-10. Rebuild the database. Go to your Laconica directory and run the
-   rebuilddb.sh script like this:
-
-   ./scripts/rebuilddb.sh rootuser rootpassword database db/laconica.sql
-
-   Here, rootuser and rootpassword are the username and password for a
-   user who can drop and create databases as well as tables; typically
-   that's _not_ the user Laconica runs as.
-11. Use mysql client to log into your database and make sure that the
-    notice, user, profile, subscription etc. tables are non-empty.
+10. Rebuild the database. For MySQL, go to your Laconica directory and
+    run the rebuilddb.sh script like this:
+
+    ./scripts/rebuilddb.sh rootuser rootpassword database db/laconica.sql
+
+    Here, rootuser and rootpassword are the username and password for a
+    user who can drop and create databases as well as tables; typically
+    that's _not_ the user Laconica runs as.
+    For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
+    which operates slightly differently. Read the documentation in that
+    script before running it.
+11. Use mysql or psql client to log into your database and make sure that
+    the notice, user, profile, subscription etc. tables are non-empty.
 12. Turn back on the Web server, and check that things still work.
 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
     bots have changed since version 0.5; see above for details.
@@ -793,7 +817,7 @@ 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 'mublog' or '/'
+path: The path part of your site's URLs, like 'mublog' or ''
       (installed in root).
 fancy: whether or not your site uses fancy URLs (see Fancy URLs
        section above). Default is false.
@@ -837,6 +861,20 @@ 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.
+dupelimit: Time in which it's not OK for the same person to post the
+           same notice; default = 60 seconds.
+logo: URL of an image file to use as the logo for the site. Overrides
+      the logo in the theme, if any.
+ssl: Whether to use SSL and https:// URLs for some or all pages.
+     Possible values are 'always' (use it for all pages), 'never'
+     (don't use it for any pages), or 'sometimes' (use it for
+     sensitive pages that include passwords like login and registration,
+     but not for regular pages). Default to 'never'.
+sslserver: use an alternate server name for SSL URLs, like
+           'secure.example.org'. You should be careful to set cookie
+           parameters correctly so that both the SSL server and the
+           "normal" server can access the session cookie and
+           preferably other cookies as well.
 
 db
 --
@@ -1081,6 +1119,23 @@ banned: an array of usernames and/or profile IDs of 'banned' profiles.
         not be accepted at all. (Compare with blacklisted users above,
         whose posts just won't show up in the public stream.)
 
+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.
+
 Troubleshooting
 ===============
 
@@ -1093,7 +1148,7 @@ repository (see below), and you get a compilation error ("unexpected
 T_STRING") in the browser, check to see that you don't have any
 conflicts in your code.
 
-If you upgraded to Laconica 0.7.1 without reading the "Notice inboxes"
+If you upgraded to Laconica 0.7.3 without reading the "Notice inboxes"
 section above, and all your users' 'Personal' tabs are empty, read the
 "Notice inboxes" section above.
 
@@ -1179,6 +1234,11 @@ if anyone's been overlooked in error.
 * Ken Sheppardson (Trac server, man-about-town)
 * Tiago 'gouki' Faria (i18n managerx)
 * Sean Murphy
+* Leslie Michael Orchard
+* Eric Helgeson
+* Ken Sedgwick
+* Brian Hendrickson
+* Tobias Diekershoff
 
 Thanks also to the developers of our upstream library code and to the
 thousands of people who have tried out Identi.ca, installed Laconi.ca,