MySQL tables created with install hook. We need PostgreSQL help with this.
[project/buddylist.git] / README.txt
1 Readme\r
2 ------\r
3 This module allows users to put each other on a personal 'Buddy List'.\r
4 \r
5 Features include buddy groups and the ability to track your buddies' recent posts.\r
6 \r
7 Send comments to Robert Douglass at: http://drupal.org/user/5449/contact\r
8 \r
9 \r
10 Requirements\r
11 ------------\r
12 This module requires Drupal 4.7.\r
13 \r
14 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\r
15 \r
16 \r
17 Upgrading from 4.6\r
18 ------------------\r
19 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\r
20 \r
21 \r
22 Installation\r
23 ------------\r
24 1. Copy the buddylist.module to the Drupal modules/ directory.\r
25 \r
26 2. Enable buddy list in the "site settings | modules" administration screen.\r
27 \r
28    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.\r
29 \r
30 3. Enable buddy list blocks you want in the "blocks" administration screen.\r
31           \r
32 4. Optionally add the following theme function to your PHPTemplate's template.php file:\r
33 \r
34 function phptemplate_username($object) {\r
35   global $user;\r
36   /* Use the default theme_username for anonymous users, nodes by this user */\r
37   if ($user->uid == 0 || $object->uid == $user->uid || $object->uid == 0) {\r
38     return theme_username($object);\r
39   }\r
40   if (!user_access('maintain buddy list')) {\r
41         return theme_username($object);\r
42   }\r
43   \r
44   /* an array, keyed on buddy uids */\r
45   $buddies = buddylist_get_buddies($user->uid);\r
46   /* Find out if this buddy is in the user's buddy list */\r
47   foreach ($buddies as $buddyuid => $buddystructure) {\r
48     if ($buddyuid == $object->uid) {\r
49       $output .= theme_username($object);\r
50       $output .= " (";\r
51       $output .= theme('remove_from_buddylist_link', $object);\r
52       $output .= ")";\r
53       return $output;\r
54     }\r
55   }\r
56   /* The user is not in the buddylist, give a link to add */\r
57   $output .= theme_username($object);\r
58   $output .= " (";\r
59   $output .= theme('add_to_buddylist_link', $object);\r
60   $output .= ")";\r
61   return $output;\r
62 }\r
63 \r
64 \r
65 Database Schema\r
66 ---------------\r
67 If the automatic creation of the database tables was unsuccessful you can try creating the tables by hand using the following SQL:\r
68 \r
69 CREATE TABLE `buddylist` (\r
70   `uid` int(10) unsigned NOT NULL default '0',\r
71   `buddy` int(10) unsigned NOT NULL default '0',\r
72   `timestamp` int(11) NOT NULL default '0',\r
73   `received` tinyint(1) NOT NULL default '0',\r
74   UNIQUE KEY `uid-buddy-label` (`uid`,`buddy`),\r
75   KEY `uid` (`uid`)\r
76 ) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */;\r
77 \r
78 -- \r
79 -- Table structure for table `buddylist_buddy_group`\r
80 -- \r
81 \r
82 CREATE TABLE `buddylist_buddy_group` (\r
83   `uid` int(11) NOT NULL default '0',\r
84   `buddy` int(11) NOT NULL default '0',\r
85   `label_id` int(11) NOT NULL default '0',\r
86   PRIMARY KEY  (`uid`,`buddy`,`label_id`)\r
87 ) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */;\r
88 \r
89 -- \r
90 -- Table structure for table `buddylist_groups`\r
91 -- \r
92 \r
93 CREATE TABLE `buddylist_groups` (\r
94   `uid` int(11) NOT NULL default '0',\r
95   `label_id` int(11) NOT NULL default '0',\r
96   `label` varchar(255) NOT NULL default '',\r
97   `visible` tinyint(1) NOT NULL default '0',\r
98   PRIMARY KEY  (`uid`,`label_id`)\r
99 ) TYPE=MyISAM /*!40100 DEFAULT CHARACTER SET utf8 */;\r
100 \r
101 \r
102 Credits\r
103 -------\r
104 Written by Adrian Rossouw.\r
105 Thanks to Ratko Kovacina for the comments/debugging info\r
106 Browsing improvements by Doug Sikora\r
107 \r
108 Maintainer: Robert Douglass\r
109 Status: maintained (Feb. 2006)\r
110 \r
111 TODO\r
112 ----\r
113 1. PGSQL schema (see buddylist.install, buddylist_install())\r
114 2. Rework texts so that one is not stuck with "buddy" but could choose "contact", for example\r
115 3. Make a workflow whereby a buddy request is sent to the buddy for confirmation which is required before the buddy can be added.\r
116 4. Make the notification that someone added you to their buddylist use the privatemsg module, if available.\r
117 5. Consider possible Views module integration.