plugin/addon API landing - still things left to do before it's useful

This commit is contained in:
Friendika 2010-12-22 14:16:22 -08:00
parent eb6cefaea3
commit 6808d53d0f
8 changed files with 171 additions and 124 deletions

85
INSTALL
View file

@ -1,85 +0,0 @@
Friendika Installation
We've tried very hard to ensure that Friendika will run on commodity hosting
platforms - such as those used to host Wordpress blogs and Drupal websites.
But be aware that Friendika is more than a simple web application. It is a
complex communications system which more closely resembles an email server
than a web server. For reliability and performance, messages are delivered in
the background and are queued for later delivery when sites are down. This
kind of functionality requires a bit more of the host system than the typical
blog. Not every PHP/MySQL hosting provider will be able to support Friendika.
Many will. But please review the requirements and confirm these with your
hosting provider prior to installation.
1. Requirements
- Apache with mod-rewrite enabled and "Options All" so you can use a
local .htaccess file
- PHP > 5.1. The later the better. You'll need 5.3 for encryption of key
exchange conversations
encryption support
- PHP *command line* access with register_argc_argv set to true in the
php.ini file
- curl, gd, mysql, and openssl extensions
- some form of email server or email gateway such that PHP mail() works
- mcrypt (optional; used for end-to-end message encryption)
- Mysql 5.x
- ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks
(Windows)
- Installation into a top-level domain or sub-domain (without a
directory/path component in the URL) is preferred. Directory paths will
not be as convenient to use and have not been thoroughly tested.
[Dreamhost.com offers all of the necessary hosting features at a
reasonable price. If your hosting provider doesn't allow Unix shell access,
you might have trouble getting everything to work.]
2. Unpack the Friendika files into the root of your web server document area.
- If you copy the directory tree to your webserver, make sure
that you also copy .htaccess - as "dot" files are often hidden
and aren't normally copied.
3. Create an empty database and note the access details (hostname, username,
password, database name).
4. Visit your website with a web browser and follow the instructions. Please
note any error messages and correct these before continuing.
5. *If* the automated installation fails for any reason, check the following:
- ".htconfig.php" exists
If not, edit htconfig.php and change system settings. Rename
to .htconfig.php
- Database is populated.
If not, import the contents of "database.sql" with phpmyadmin
or mysql command line
6. At this point visit your website again, and register your personal account.
Registration errors should all be recoverable automatically.
If you get any *critical* failure at this point, it generally indicates the
database was not installed correctly. You might wish to move/rename
.htconfig.php to another name and empty (called 'dropping') the database
tables, so that you can start fresh.
7. Set up a cron job or scheduled task to run the poller once every 5-10
minutes to pick up the recent "public" postings of your friends. Example:
cd /base/directory; /path/to/php include/poller.php
Change "/base/directory", and "/path/to/php" as appropriate for your situation.
If you are using a Linux server, run "crontab -e" and add a line like the
one shown, substituting for your unique paths and settings:
*/10 * * * * cd /home/myname/mywebsite; /usr/bin/php include/poller.php
You can generally find the location of PHP by executing "which php". If you
have troubles with this section please contact your hosting provider for
assistance. Friendika will not work correctly if you cannot perform this step.

View file

@ -2,7 +2,7 @@
set_time_limit(0); set_time_limit(0);
define ( 'BUILD_ID', 1027 ); define ( 'BUILD_ID', 1028 );
define ( 'DFRN_PROTOCOL_VERSION', '2.0' ); define ( 'DFRN_PROTOCOL_VERSION', '2.0' );
define ( 'EOL', "<br />\r\n" ); define ( 'EOL', "<br />\r\n" );
@ -35,6 +35,13 @@ define ( 'REL_VIP', 1);
define ( 'REL_FAN', 2); define ( 'REL_FAN', 2);
define ( 'REL_BUD', 3); define ( 'REL_BUD', 3);
/**
* Hook array order
*/
define ( 'HOOK_HOOK', 0);
define ( 'HOOK_FILE', 1);
define ( 'HOOK_FUNCTION', 2);
/** /**
* *
@ -372,7 +379,8 @@ function system_unavailable() {
// Primarily involved with database upgrade, but also sets the // Primarily involved with database upgrade, but also sets the
// base url for use in cmdline programs which don't have // base url for use in cmdline programs which don't have
// $_SERVER variables. // $_SERVER variables, and synchronising the state of installed plugins.
if(! function_exists('check_config')) { if(! function_exists('check_config')) {
function check_config(&$a) { function check_config(&$a) {
@ -404,6 +412,65 @@ function check_config(&$a) {
set_config('system','build', BUILD_ID); set_config('system','build', BUILD_ID);
} }
} }
/**
*
* Synchronise plugins:
*
* $a->config['system']['addon'] contains a comma-separated list of names
* of plugins/addons which are used on this system.
* Go through the database list of already installed addons, and if we have
* an entry, but it isn't in the config list, call the uninstall procedure
* and mark it uninstalled in the database (for now we'll remove it).
* Then go through the config list and if we have a plugin that isn't installed,
* call the install procedure and add it to the database.
*
*/
$r = q("SELECT * FROM `addon` WHERE `installed` = 1");
if(count($r))
$installed = $r;
$plugins = get_config('system','addon');
$plugins_arr = array();
if($plugins)
$plugins_arr = explode(',',str_replace(' ', '',$plugins));
$installed_arr = array();
foreach($installed as $i) {
if(! in_array($i['name'],$plugins_arr)) {
logger("Addons: uninstalling " . $i['name']);
q("DELETE FROM `addon` WHERE `id` = %d LIMIT 1",
intval($i['id'])
);
@include_once('addon/' . $i['name'] . '/' . $i['name'] . '.php');
if(function_exists($i['name'] . '_uninstall')) {
$func = $i['name'] . '_uninstall';
$func();
}
}
else
$installed_arr[] = $i['name'];
}
if(count($plugins_arr)) {
foreach($plugins_arr as $p) {
if(! in_array($p,$installed_arr)) {
logger("Addons: installing " . $p);
@include_once('addon/' . $p . '/' . $p . '.php');
if(function_exists($p . '_install')) {
$func = $p . '_install';
$func();
$r = q("INSERT INTO `addon` (`name`, `installed`) VALUES ( '%s', 1 ) ",
dbesc($p)
);
}
}
}
}
return; return;
}} }}
@ -1991,10 +2058,10 @@ function call_hooks($name, $data = null) {
if(count($a->hooks)) { if(count($a->hooks)) {
foreach($a->hooks as $hook) { foreach($a->hooks as $hook) {
if($hook[0] === $name) { if($hook[HOOK_HOOK] === $name) {
@require_once($hook[1]); @include_once($hook[HOOK_FILE]);
if(function_exists($hook[2])) { if(function_exists($hook[HOOK_FUNCTION])) {
$func = $hook[2]; $func = $hook[HOOK_FUNCTION];
$func($a,$data); $func($a,$data);
} }
} }

View file

@ -441,3 +441,13 @@ CREATE TABLE IF NOT EXISTS `hook` (
) ENGINE = MYISAM DEFAULT CHARSET=utf8; ) ENGINE = MYISAM DEFAULT CHARSET=utf8;
CREATE TABLE IF NOT EXISTS `addon` (
`id` INT NOT NULL AUTO_INCREMENT PRIMARY KEY ,
`name` CHAR( 255 ) NOT NULL ,
`version` CHAR( 255 ) NOT NULL ,
`installed` TINYINT( 1 ) NOT NULL DEFAULT '0'
) ENGINE = MYISAM DEFAULT CHARSET=utf8;

View file

@ -610,6 +610,8 @@ function item_store($arr) {
} }
} }
call_hooks('post_remote',$arr);
dbesc_array($arr); dbesc_array($arr);
logger('item_store: ' . print_r($arr,true), LOGGER_DATA); logger('item_store: ' . print_r($arr,true), LOGGER_DATA);

View file

@ -182,7 +182,7 @@ function follow_post(&$a) {
); );
if((x($contact,'notify')) && (strlen($contact['notify']))) { if((count($r)) && (x($contact,'notify')) && (strlen($contact['notify']))) {
require_once('include/salmon.php'); require_once('include/salmon.php');
slapper($r[0],$contact['notify'],$slap); slapper($r[0],$contact['notify'],$slap);
} }

View file

@ -81,8 +81,10 @@ function item_post(&$a) {
// get contact info for poster // get contact info for poster
$author = null; $author = null;
$self = false;
if(($_SESSION['uid']) && ($_SESSION['uid'] == $profile_uid)) { if(($_SESSION['uid']) && ($_SESSION['uid'] == $profile_uid)) {
$self = true;
$r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `self` = 1 LIMIT 1", $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `self` = 1 LIMIT 1",
intval($_SESSION['uid']) intval($_SESSION['uid'])
); );
@ -206,40 +208,82 @@ function item_post(&$a) {
$uri = item_new_uri($a->get_hostname(),$profile_uid); $uri = item_new_uri($a->get_hostname(),$profile_uid);
$datarray = array();
$datarray['uid'] = $profile_uid;
$datarray['type'] = $post_type;
$datarray['wall'] = $wall;
$datarray['gravity'] = $gravity;
$datarray['contact-id'] = $contact_id;
$datarray['owner-name'] = $contact_record['name'];
$datarray['owner-link'] = $contact_record['url'];
$datarray['owner-avatar'] = $contact_record['thumb'];
$datarray['author-name'] = $author['name'];
$datarray['author-link'] = $author['url'];
$datarray['author-avatar'] = $author['thumb'];
$datarray['created'] = datetime_convert();
$datarray['edited'] = datetime_convert();
$datarray['changed'] = datetime_convert();
$datarray['uri'] = $uri;
$datarray['title'] = $title;
$datarray['body'] = $body;
$datarray['location'] = $location;
$datarray['coord'] = $coord;
$datarray['tag'] = $str_tags;
$datarray['inform'] = $inform;
$datarray['verb'] = $verb;
$datarray['allow_cid'] = $str_contact_allow;
$datarray['allow_gid'] = $str_group_allow;
$datarray['deny_cid'] = $str_contact_deny;
$datarray['deny_gid'] = $str_group_deny;
$datarray['private'] = $private;
/**
* These fields are for the convenience of plugins...
* 'self' if true indicates the owner is posting on their own wall
* If parent is 0 it is a top-level post.
*/
$datarray['parent'] = $parent;
$datarray['self'] = $self;
call_hooks('post_local',$datarray);
$r = q("INSERT INTO `item` (`uid`,`type`,`wall`,`gravity`,`contact-id`,`owner-name`,`owner-link`,`owner-avatar`, $r = q("INSERT INTO `item` (`uid`,`type`,`wall`,`gravity`,`contact-id`,`owner-name`,`owner-link`,`owner-avatar`,
`author-name`, `author-link`, `author-avatar`, `created`, `edited`, `changed`, `uri`, `title`, `body`, `location`, `coord`, `author-name`, `author-link`, `author-avatar`, `created`, `edited`, `changed`, `uri`, `title`, `body`, `location`, `coord`,
`tag`, `inform`, `verb`, `allow_cid`, `allow_gid`, `deny_cid`, `deny_gid`, `private` ) `tag`, `inform`, `verb`, `allow_cid`, `allow_gid`, `deny_cid`, `deny_gid`, `private` )
VALUES( %d, '%s', %d, %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d )", VALUES( %d, '%s', %d, %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d )",
intval($profile_uid), intval($datarray['uid']),
dbesc($post_type), dbesc($datarray['type']),
intval($wall), intval($datarray['wall']),
intval($gravity), intval($datarray['gravity']),
intval($contact_id), intval($datarray['contact-id']),
dbesc($contact_record['name']), dbesc($datarray['owner-name']),
dbesc($contact_record['url']), dbesc($datarray['owner-link']),
dbesc($contact_record['thumb']), dbesc($datarray['owner-avatar']),
dbesc($author['name']), dbesc($datarray['author-name']),
dbesc($author['url']), dbesc($datarray['author-link']),
dbesc($author['thumb']), dbesc($datarray['author-avatar']),
dbesc(datetime_convert()), dbesc($datarray['created']),
dbesc(datetime_convert()), dbesc($datarray['edited']),
dbesc(datetime_convert()), dbesc($datarray['changed']),
dbesc($uri), dbesc($datarray['uri']),
dbesc($title), dbesc($datarray['title']),
dbesc($body), dbesc($datarray['body']),
dbesc($location), dbesc($datarray['location']),
dbesc($coord), dbesc($datarray['coord']),
dbesc($str_tags), dbesc($datarray['tag']),
dbesc($inform), dbesc($datarray['inform']),
dbesc($verb), dbesc($datarray['verb']),
dbesc($str_contact_allow), dbesc($datarray['allow_cid']),
dbesc($str_group_allow), dbesc($datarray['allow_gid']),
dbesc($str_contact_deny), dbesc($datarray['deny_cid']),
dbesc($str_group_deny), dbesc($datarray['deny_gid']),
intval($private) intval($datarray['private'])
); );
$r = q("SELECT `id` FROM `item` WHERE `uri` = '%s' LIMIT 1", $r = q("SELECT `id` FROM `item` WHERE `uri` = '%s' LIMIT 1",
dbesc($uri)); dbesc($datarray['uri']));
if(count($r)) { if(count($r)) {
$post_id = $r[0]['id']; $post_id = $r[0]['id'];
logger('mod_item: saved item ' . $post_id); logger('mod_item: saved item ' . $post_id);
@ -276,7 +320,7 @@ function item_post(&$a) {
'$email' => $user['email'], '$email' => $user['email'],
'$from' => $from, '$from' => $from,
'$display' => $a->get_baseurl() . '/display/' . $user['nickname'] . '/' . $post_id, '$display' => $a->get_baseurl() . '/display/' . $user['nickname'] . '/' . $post_id,
'$body' => strip_tags(bbcode($body)) '$body' => strip_tags(bbcode($datarray['body']))
)); ));
$res = mail($user['email'], $from . t(" commented on your item at ") . $a->config['sitename'], $res = mail($user['email'], $from . t(" commented on your item at ") . $a->config['sitename'],
@ -299,7 +343,7 @@ function item_post(&$a) {
'$email' => $user['email'], '$email' => $user['email'],
'$from' => $from, '$from' => $from,
'$display' => $a->get_baseurl() . '/display/' . $user['nickname'] . '/' . $post_id, '$display' => $a->get_baseurl() . '/display/' . $user['nickname'] . '/' . $post_id,
'$body' => strip_tags(bbcode($body)) '$body' => strip_tags(bbcode($datarray['body']))
)); ));
$res = mail($user['email'], $from . t(" posted on your profile wall at ") . $a->config['sitename'], $res = mail($user['email'], $from . t(" posted on your profile wall at ") . $a->config['sitename'],
@ -352,7 +396,7 @@ function item_post(&$a) {
'cookie' => true 'cookie' => true
)); ));
try { try {
$statusUpdate = $facebook->api('/me/feed', 'post', array('message'=> bbcode($body), 'cb' => '')); $statusUpdate = $facebook->api('/me/feed', 'post', array('message'=> bbcode($datarray['body']), 'cb' => ''));
} }
catch (FacebookApiException $e) { catch (FacebookApiException $e) {
notice( t('Facebook status update failed.') . EOL); notice( t('Facebook status update failed.') . EOL);

View file

@ -261,3 +261,12 @@ function update_1026() {
} }
function update_1027() {
q("CREATE TABLE IF NOT EXISTS `addon` (
`id` INT NOT NULL AUTO_INCREMENT PRIMARY KEY ,
`name` CHAR( 255 ) NOT NULL ,
`version` CHAR( 255 ) NOT NULL ,
`installed` TINYINT( 1 ) NOT NULL DEFAULT '0'
) ENGINE = MYISAM DEFAULT CHARSET=utf8 ");
}

View file

@ -76,7 +76,7 @@ $profile_in_net_dir
<div id="settings-default-perms" class="settings-default-perms" > <div id="settings-default-perms" class="settings-default-perms" >
<div id="settings-default-perms-menu" class="fakelink" onClick="openClose('settings-default-perms-select');" >$permissions</div> <div id="settings-default-perms-menu" class="fakelink" onClick="openClose('settings-default-perms-select');" >&#x21e9; $permissions</div>
<div id="settings-default-perms-menu-end"></div> <div id="settings-default-perms-menu-end"></div>
<div id="settings-default-perms-select" style="display: none;" > <div id="settings-default-perms-select" style="display: none;" >