diff --git a/CREDITS b/CREDITS deleted file mode 100644 index 399e4ce30eb3a8dc6076f78ca6d07f94b5cbd1ab..0000000000000000000000000000000000000000 --- a/CREDITS +++ /dev/null @@ -1,3 +0,0 @@ -Written by Adrian Rossouw -Thanks to Ratko Kovacina for the comments/debugging info -Browsing improvements by Doug Sikora diff --git a/INSTALL.txt b/INSTALL.txt deleted file mode 100644 index 6a327198d26938c4b9094672873e11e4ccaab353..0000000000000000000000000000000000000000 --- a/INSTALL.txt +++ /dev/null @@ -1,56 +0,0 @@ -Readme ------- -This module allows users to put each other on a personal 'Buddy List' , -also enabling them to keep up with their friend's postings via the 'My Friend's Blogs' block. - -Send comments to adrian@daemon.co.za. - -Requirements ------------- -This module requires Drupal 4.4.0 or CVS from March 25 2004 or later. - -Installation ------------- -1. Create the SQL tables. This depends a little on your system, but the most - common method is: - mysql -u username -ppassword drupal < buddylist.mysql - - Postgres database initialization file is also included, but not tested. - -2. Copy the buddylist.module to the Drupal modules/ directory. - -3. Enable buddy list in the "site settings | modules" administration screen. - -4. Enable buddy list blocks you want in the "blocks" administration screen. - -5. Optionally add the following theme function to your PHPTemplate's template.php file: - -function phptemplate_username($object) { - global $user; - /* Use the default theme_username for anonymous users, nodes by this user */ - if ($user->uid == 0 || $object->uid == $user->uid || $object->uid == 0) { - return theme_username($object); - } - if (!user_access('maintain buddy list')) { - return theme_username($object); - } - - /* an array, keyed on buddy uids */ - $buddies = buddylist_get_buddies($user->uid); - /* Find out if this buddy is in the user's buddy list */ - foreach ($buddies as $buddyuid => $buddystructure) { - if ($buddyuid == $object->uid) { - $output .= theme_username($object); - $output .= " ("; - $output .= theme('remove_from_buddylist_link', $object); - $output .= ")"; - return $output; - } - } - /* The user is not in the buddylist, give a link to add */ - $output .= theme_username($object); - $output .= " ("; - $output .= theme('add_to_buddylist_link', $object); - $output .= ")"; - return $output; -} diff --git a/README.txt b/README.txt index f0c3ffa1d78641da2fa76cbfb59944e277662760..f968102ef384cc36dca958da8b7af7de2ddc54a0 100644 --- a/README.txt +++ b/README.txt @@ -1,9 +1,117 @@ -Readme ------- -This module allows users to put each other on a personal 'Buddy List' , -also enabling them to keep up with their friend's postings via the 'My Friend's Blogs' block. - -Users may put their buddies into groups, like many instant messaging applications. These groups may be used for controlling access to nodes using the buddylist_access.module - -Send comments to walkah@walkah.net. - +Readme +------ +This module allows users to put each other on a personal 'Buddy List'. + +Features include buddy groups and the ability to track your buddies' recent posts. + +Send comments to Robert Douglass at: http://drupal.org/user/5449/contact + + +Requirements +------------ +This module requires Drupal 4.7. + +This module does not yet offer PostgreSQL support. If you would like to contribute to this module by creating the appropriate PostgreSQL schema, please submit your code at http://drupal.org/project/issues/buddylist + + +Upgrading from 4.6 +------------------ +WARNING: There is currently no migration path from 4.6 to 4.7. There are significant database schema changes and the 4.7 module will not work with the 4.6 schema. A migration path is forthcoming. If you need one sooner, contact me: http://drupal.org/user/5449/contact + + +Installation +------------ +1. Copy the buddylist.module to the Drupal modules/ directory. + +2. Enable buddy list in the "site settings | modules" administration screen. + + Enabling the buddylist module will trigger the creation of the database schema. If you are shown error messages you may have to create the schema by hand. Please see the database definition at the end of this file. + +3. Enable buddy list blocks you want in the "blocks" administration screen. + +4. Optionally add the following theme function to your PHPTemplate's template.php file: + +function phptemplate_username($object) { + global $user; + /* Use the default theme_username for anonymous users, nodes by this user */ + if ($user->uid == 0 || $object->uid == $user->uid || $object->uid == 0) { + return theme_username($object); + } + if (!user_access('maintain buddy list')) { + return theme_username($object); + } + + /* an array, keyed on buddy uids */ + $buddies = buddylist_get_buddies($user->uid); + /* Find out if this buddy is in the user's buddy list */ + foreach ($buddies as $buddyuid => $buddystructure) { + if ($buddyuid == $object->uid) { + $output .= theme_username($object); + $output .= " ("; + $output .= theme('remove_from_buddylist_link', $object); + $output .= ")"; + return $output; + } + } + /* The user is not in the buddylist, give a link to add */ + $output .= theme_username($object); + $output .= " ("; + $output .= theme('add_to_buddylist_link', $object); + $output .= ")"; + return $output; +} + + +Database Schema +--------------- +If the automatic creation of the database tables was unsuccessful you can try creating the tables by hand using the following SQL: + +CREATE TABLE `buddylist` ( + `uid` int(10) unsigned NOT NULL default '0', + `buddy` int(10) unsigned NOT NULL default '0', + `timestamp` int(11) NOT NULL default '0', + `received` tinyint(1) NOT NULL default '0', + UNIQUE KEY `uid-buddy-label` (`uid`,`buddy`), + KEY `uid` (`uid`) +) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */; + +-- +-- Table structure for table `buddylist_buddy_group` +-- + +CREATE TABLE `buddylist_buddy_group` ( + `uid` int(11) NOT NULL default '0', + `buddy` int(11) NOT NULL default '0', + `label_id` int(11) NOT NULL default '0', + PRIMARY KEY (`uid`,`buddy`,`label_id`) +) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */; + +-- +-- Table structure for table `buddylist_groups` +-- + +CREATE TABLE `buddylist_groups` ( + `uid` int(11) NOT NULL default '0', + `label_id` int(11) NOT NULL default '0', + `label` varchar(255) NOT NULL default '', + `visible` tinyint(1) NOT NULL default '0', + PRIMARY KEY (`uid`,`label_id`) +) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */; + + +Credits +------- +Written by Adrian Rossouw. +Thanks to Ratko Kovacina for the comments/debugging info +Browsing improvements by Doug Sikora + +Maintainer: Robert Douglass +Status: maintained (Feb. 2006) + +TODO +---- +1. PGSQL schema (see buddylist.install, buddylist_install()) +2. Rework texts so that one is not stuck with "buddy" but could choose "contact", for example +3. Make a workflow whereby a buddy request is sent to the buddy for confirmation which is required before the buddy can be added. +4. Make the notification that someone added you to their buddylist use the privatemsg module, if available. +5. Consider possible Views module integration. \ No newline at end of file diff --git a/TODO b/TODO deleted file mode 100644 index e74cb12efff2fb8de999e03ed08a2d07caff74a2..0000000000000000000000000000000000000000 --- a/TODO +++ /dev/null @@ -1,4 +0,0 @@ -- Using Node Api, create access restrictions whereby users can set nodes to be private,public or buddies only. -- Add key to pgsql file -- Update translations -- Audit permissions diff --git a/buddylist.install b/buddylist.install index f484e7b814037b02733de3a9bc07e6183d090453..e16ac6f528712fdb5276d4306bb88e3a36124ce6 100755 --- a/buddylist.install +++ b/buddylist.install @@ -1,5 +1,61 @@ - \ No newline at end of file +