From 2028e1695c82685102a7eef7f75094267446a887 Mon Sep 17 00:00:00 2001 From: Mike Macgirvin Date: Tue, 26 Oct 2010 22:09:13 -0700 Subject: [PATCH] rework the logging interface --- boot.php | 12 ++++++++ include/dba.php | 7 +++-- include/items.php | 3 +- include/notifier.php | 5 +--- include/salmon.php | 11 ++++---- mod/pubsub.php | 10 ++----- mod/salmon.php | 66 ++++++++++++++------------------------------ 7 files changed, 47 insertions(+), 67 deletions(-) diff --git a/boot.php b/boot.php index 1c00598b31..5cb091eaec 100644 --- a/boot.php +++ b/boot.php @@ -1276,3 +1276,15 @@ function attribute_contains($attr,$s) { return false; }} +if(! function_exists('logger')) { +function logger($msg) { + + $debugging = get_config('system','debugging'); + $logfile = get_config('system','logfile'); + + if((! $debugging) || (! $logfile)) + return; + + @file_put_contents($logfile, datetime_convert() . ':' . session_id() . ' ' . $msg . "\n", FILE_APPEND); + return; +}} diff --git a/include/dba.php b/include/dba.php index 0e790d4c1c..133b596efa 100644 --- a/include/dba.php +++ b/include/dba.php @@ -58,8 +58,11 @@ class dba { } } else { - if(($result === false) && (file_exists('dbfail.out'))) - file_put_contents('dbfail.out', printable($sql) . ' returned false' . "\n", FILE_APPEND); + if($result === false) { + logger('dba: ' . printable($sql) . ' returned false.'); + if(file_exists('dbfail.out')) + file_put_contents('dbfail.out', printable($sql) . ' returned false' . "\n", FILE_APPEND); + } } if(($result === true) || ($result === false)) diff --git a/include/items.php b/include/items.php index fa07727de1..f11bebf50f 100644 --- a/include/items.php +++ b/include/items.php @@ -923,8 +923,7 @@ function consume_feed($xml,$importer,$contact, &$hub) { $datarray = get_atom_elements($feed,$item); if($datarray['verb'] === ACTIVITY_FOLLOW) { - if($debugging) - file_put_contents('salmon.out',"\n" . 'New follower.' . "\n", FILE_APPEND); + logger('consume-feed: New follower'); new_follower($importer,$contact,$datarray,$item); return; } diff --git a/include/notifier.php b/include/notifier.php index 069f3bdf2e..cd75c1fff8 100644 --- a/include/notifier.php +++ b/include/notifier.php @@ -343,10 +343,7 @@ continue; $params = 'hub.mode=publish&hub.url=' . urlencode($a->get_baseurl() . '/dfrn_poll/' . $owner['nickname'] ); post_url($h,$params); - if($debugging) { - file_put_contents('pubsub.out', "\n\n" . "Pinged hub " . $h . ' at ' - . datetime_convert() . "\n" . "Hub returned " . $a->get_curl_code() . "\n\n" , FILE_APPEND); - } + logger('pubsub: publish: ' . $h . ' returned ' . $a->get_curl_code()); if(count($hubs) > 1) sleep(7); // try and avoid multiple hubs responding at precisely the same time } diff --git a/include/salmon.php b/include/salmon.php index e93ec23d76..872dcd5f31 100644 --- a/include/salmon.php +++ b/include/salmon.php @@ -29,9 +29,7 @@ function base64url_decode($s) { function get_salmon_key($uri,$keyhash) { $ret = array(); - $debugging = get_config('system','debugging'); - if($debugging) - file_put_contents('salmon.out', "\n" . 'Fetch key' . "\n", FILE_APPEND); + logger('Fetching salmon key'); $arr = lrdd($uri); @@ -62,8 +60,8 @@ function get_salmon_key($uri,$keyhash) { } } - if($debugging) - file_put_contents('salmon.out', "\n" . 'Key located: ' . print_r($ret,true) . "\n", FILE_APPEND); + + logger('Key located: ' . print_r($ret,true)); if(count($ret) == 1) { @@ -90,6 +88,7 @@ function get_salmon_key($uri,$keyhash) { function slapper($owner,$contact,$slap) { + logger('slapper called. Data: ' . $slap); // does contact have a salmon endpoint? @@ -180,7 +179,7 @@ EOT; $return_code = trim($a->get_curl_code()); } - + logger('slapper returned ' . $return_code); return; } diff --git a/mod/pubsub.php b/mod/pubsub.php index 1b69cc5f93..28e8356eb4 100644 --- a/mod/pubsub.php +++ b/mod/pubsub.php @@ -39,10 +39,7 @@ function pubsub_init(&$a) { $hub_lease = notags(trim($_GET['hub_lease_seconds'])); $hub_verify = notags(trim($_GET['hub_verify_token'])); - $debugging = get_config('system','debugging'); - if($debugging) { - file_put_contents('pubsub.out', 'Pubsubhubbub subscription called from ' . $_SERVER['REMOTE_ADDR'] . ' at ' . datetime_convert() . "\n" . print_r($_GET,true), FILE_APPEND); - } + logger('pubsub: Subscription from' . $_SERVER['REMOTE_ADDR'] . print_r($_GET,true)); $subscribe = (($hub_mode === 'subscribe') ? 1 : 0); @@ -89,10 +86,7 @@ function pubsub_post(&$a) { $xml = file_get_contents('php://input'); - $debugging = get_config('system','debugging'); - $remote_host = 'Pubsub feed arrived from ' . $_SERVER['REMOTE_ADDR'] . ' at ' . datetime_convert() . ' for ' . $a->cmd . "\n\n"; - if($debugging) - file_put_contents('pubsub.out', $remote_host . $xml, FILE_APPEND); + logger('pubsub: feed arrived from ' . $_SERVER['REMOTE_ADDR'] . ' for ' . $a->cmd . ':' . $xml); $nick = (($a->argc > 1) ? notags(trim($a->argv[1])) : ''); $contact_id = (($a->argc > 2) ? intval($a->argv[2]) : 0); diff --git a/mod/salmon.php b/mod/salmon.php index 54353132ad..2acb094c31 100644 --- a/mod/salmon.php +++ b/mod/salmon.php @@ -12,11 +12,12 @@ require_once('simplepie/simplepie.inc'); function salmon_return($val) { - if($val >= 500) + if($val >= 400) $err = 'Error'; if($val == 200) $err = 'OK'; - + + logger('mod-salmon returns ' . $val); header($_SERVER["SERVER_PROTOCOL"] . ' ' . $val . ' ' . $err); killme(); @@ -25,10 +26,8 @@ function salmon_return($val) { function salmon_post(&$a) { $xml = file_get_contents('php://input'); - - $debugging = get_config('system','debugging'); - if($debugging) - file_put_contents('salmon.out','New Salmon: ' . $xml . "\n",FILE_APPEND); + + logger('mod-salmon: new salmon ' . $xml); $nick = (($a->argc > 1) ? notags(trim($a->argv[1])) : ''); $mentions = (($a->argc > 2 && $a->argv[2] === 'mention') ? true : false); @@ -45,10 +44,6 @@ function salmon_post(&$a) { $dom = simplexml_load_string($xml,'SimpleXMLElement',0,NAMESPACE_SALMON_ME); - - if($debugging) - file_put_contents('salmon.out', "\n" . print_r($dom,true) . "\n" , FILE_APPEND); - // figure out where in the DOM tree our data is hiding if($dom->provenance->data) @@ -59,9 +54,8 @@ function salmon_post(&$a) { $base = $dom; if(! $base) { - if($debugging) - file_put_contents('salmon.out', "\n" . 'Unable to find salmon data in XML' . "\n" , FILE_APPEND); - salmon_return(500); + logger('mod-salmon: unable to locate salmon data in xml '); + salmon_return(400); } // Stash the signature away for now. We have to find their key or it won't be good for anything. @@ -69,9 +63,6 @@ function salmon_post(&$a) { $signature = base64url_decode($base->sig); - if($debugging) - file_put_contents('salmon.out', "\n" . 'Encoded Signature: ' . $base->sig . "\n" , FILE_APPEND); - // unpack the data // strip whitespace so our data element will return to one big base64 blob @@ -104,9 +95,7 @@ function salmon_post(&$a) { $feedxml = $tpl . $base . ''; - if($debugging) { - file_put_contents('salmon.out', 'Processed feed: ' . $feedxml . "\n", FILE_APPEND); - } + logger('mod-salmon: Processed feed: ' . $feedxml); // Now parse it like a normal atom feed to scrape out the author URI @@ -115,10 +104,7 @@ function salmon_post(&$a) { $feed->enable_order_by_date(false); $feed->init(); - if($debugging) { - file_put_contents('salmon.out', "\n" . 'Feed parsed.' . "\n", FILE_APPEND); - } - + logger('mod-salmon: Feed parsed.'); if($feed->get_item_quantity()) { foreach($feed->get_items() as $item) { @@ -129,23 +115,20 @@ function salmon_post(&$a) { } if(! $author_link) { - if($debugging) - file_put_contents('salmon.out',"\n" . 'Could not retrieve author URI.' . "\n", FILE_APPEND); - salmon_return(500); + logger('mod-salmon: Could not retrieve author URI.'); + salmon_return(400); } // Once we have the author URI, go to the web and try to find their public key - if($debugging) { - file_put_contents('salmon.out', "\n" . 'Fetching key for ' . $author_link . "\n", FILE_APPEND); - } + logger('mod-salmon: Fetching key for ' . $author_link ); + $key = get_salmon_key($author_link,$keyhash); if(! $key) { - if($debugging) - file_put_contents('salmon.out',"\n" . 'Could not retrieve author key.' . "\n", FILE_APPEND); - salmon_return(500); + logger('mod-salmon: Could not retrieve author key.'); + salmon_return(400); } // Setup RSA stuff to verify the signature @@ -159,8 +142,7 @@ function salmon_post(&$a) { $m = base64url_decode($key_info[1]); $e = base64url_decode($key_info[2]); - if($debugging) - file_put_contents('salmon.out',"\n" . print_r($key_info,true) . "\n", FILE_APPEND); + logger('mod-salmon: key details: ' . print_r($key_info,true)); $rsa = new CRYPT_RSA(); $rsa->signatureMode = CRYPT_RSA_SIGNATURE_PKCS1; @@ -180,13 +162,11 @@ function salmon_post(&$a) { $verify = $rsa->verify($stnet_signed_data,$signature); if(! $verify) { - if($debugging) - file_put_contents('salmon.out',"\n" . 'Message did not verify. Discarding.' . "\n", FILE_APPEND); - salmon_return(500); + logger('mod-salmon: Message did not verify. Discarding.'); + salmon_return(400); } - if($debugging) - file_put_contents('salmon.out',"\n" . 'Message verified.' . "\n", FILE_APPEND); + logger('mod-salmon: Message verified.'); /* @@ -202,18 +182,14 @@ function salmon_post(&$a) { intval($importer['uid']) ); if(! count($r)) { - if($debugging) - file_put_contents('salmon.out',"\n" . 'Author unknown to us.' . "\n", FILE_APPEND); - + logger('mod-salmon: Author unknown to us.'); } if((count($r)) && ($r[0]['readonly'])) { - if($debugging) - file_put_contents('salmon.out',"\n" . 'Ignoring this author.' . "\n", FILE_APPEND); + logger('mod-salmon: Ignoring this author.'); salmon_return(200); // NOTREACHED } - require_once('include/items.php'); // Placeholder for hub discovery. We shouldn't find any hubs