X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=ctdlphp%2Fctdlprotocol.php;h=80b5a3219739f227664bb79942009ca944a0d5e1;hb=fa2dd842abb5feedea3e2253255722fcaecc3c6f;hp=50a3e012a2ad9306bdb0220393832dd350e52229;hpb=ff6b88ee11a3bb07d630d2255d6defbb7d8330a0;p=citadel.git diff --git a/ctdlphp/ctdlprotocol.php b/ctdlphp/ctdlprotocol.php index 50a3e012a..80b5a3219 100644 --- a/ctdlphp/ctdlprotocol.php +++ b/ctdlphp/ctdlprotocol.php @@ -1,21 +1,892 @@ +// One program is released under the terms of the GNU General Public License. +include "config_ctdlclient.php"; -function test_for_echo() { +define('VIEW_BBS' ,'0'); /* Bulletin board view */ +define('VIEW_MAILBOX' ,'1'); /* Mailbox summary */ +define('VIEW_ADDRESSBOOK' ,'2'); /* Address book view */ +define('VIEW_CALENDAR' ,'3'); /* Calendar view */ +define('VIEW_TASKS' ,'4'); /* Tasks view */ +define('VIEW_NOTES' ,'5'); /* Notes view */ +define("FMT_CITADEL", 0); +define("FMT_FIXED", 1); +define("FMT_RFC822", 4); - global $clientsocket, $session; +function debugLog($string) +{ + print ($string); +} + +function dbgprintf_wrapin($string, $html) +{ + if (!CITADEL_DEBUG_HTML){ + if ($html) + debugLog("<< ".$string."\n"); + } + else + printf($string); +} +function dbgprintf_wrapout($string, $html) +{ + if (!CITADEL_DEBUG_HTML){ + if ($html) + debugLog("<< ".$string."\n"); + } + else + printf($string); + +} +//-------------------------------------------------------------------------------- +// internal functions for server communication +//-------------------------------------------------------------------------------- +// +// serv_gets() -- generic function to read one line of text from the server +// +function serv_gets($readblock=FALSE) { + global $clientsocket; + + $buf = fgets($clientsocket, 4096); // Read line + $buf = substr($buf, 0, (strlen($buf)-1) ); // strip trailing LF + if (CITADEL_DEBUG_CITPROTO == 1) { + if (!$readblock) dbgprintf_wrapin("
", false); + dbgprintf_wrapout(print_r($server_info, true), true); + dbgprintf_wrapout("", false); + } + return $server_info; + } + else + { + dbgprintf_wrapin ("didn't understand the reply to the INFO command". + print_r($reply, TRUE), false); + + die ("CTDLPHP: didn't understand the reply to the INFO command"); + } +} + +// +// Learn all sorts of interesting things about the Citadel server to +// which we are connected. +/* http://www.citadel.org/doku.php/documentation:appproto:connection#info.get.server.info */ +// +function ctdl_get_registration_info() { + serv_puts("GREG"); + $reply = read_array(); + dbgprintf_wrapout(print_r($reply, true), true); +// die ("didn't understand the reply to the INFO command"); + +} + + +// +// Display a system banner. (Returns completed HTML.) +// (One is probably temporary because it outputs more or less finalized +// markup. For now it's just usable.) +// +/* http://www.citadel.org/doku.php/documentation:appproto:connection#mesg.read.system.message */ +function ctdl_mesg($msgname) { + global $clientsocket; + + $msgtext = "
", false); + dbgprintf_wrapout(print_r($oneline, true), true); + dbgprintf_wrapout("", false);; + + } + + + $num_lines = array_push($all_lines, $oneline); + } + + return array($num_lines, $all_lines); + +} + + +// +// Goto a room. +// +function ctdl_goto($to_where) { + + serv_puts("GOTO " . $to_where); + $response = serv_gets(); + + $results = explode ("|", $response); + $status_room = array_shift($results); + $status = substr($status_room, 0, 3); + if (substr($status, 0, 1) == "2") { + $room = substr($status_room, 4); + array_unshift($results, $room); + $room_state=array( + "state" => TRUE, + "statereply" => $status, + "roomname" => $results[ 0], + "nunreadmsg" => $results[ 1], + "nmessages" => $results[ 2], + "rinfopresent" => $results[ 3], + "flags" => $results[ 4], + "msgidmax" => $results[ 5], + "msgidreadmax" => $results[ 6], + "ismailroom" => $results[ 7], + "isroomaide" => $results[ 8], + "nnewmessages" => $results[ 9], + "floorid" => $results[10], + "viewselected" => $results[11], + "defaultview" => $results[12], + "istrashcan" => $results[13]); + + $_SESSION["room"] = $room; + if (CITADEL_DEBUG_CITPROTO == 1) + { + dbgprintf_wrapout("
", false); + dbgprintf_wrapout(print_r($room_state, true), true); + dbgprintf_wrapout("", false); + + } + + return $room_state; + } + + else { + return array("state" => FALSE, "statereply" => $status); + } + +} + + + +// +// Fetch the list of known rooms. +// +function ctdl_knrooms() { + global $clientsocket; + + serv_puts("LKRA"); + $response = serv_gets(); + if (substr($response, 0, 1) != "1") { + return array(0, NULL); + } + $results = read_array(); + $all_lines = array(); + $num_lines = 0; + + foreach ($results as $result){ + $oneline = array(); + $tokens = explode("|",$result); + + $oneline["name"] = $tokens[0]; + $oneline["flags"] = $tokens[1]; + $oneline["floor"] = $tokens[2]; + $oneline["order"] = $tokens[3]; + $oneline["flags2"] = $tokens[4]; + $oneline["access"] = $tokens[5]; + + if ($oneline["access"] & 8) { + $oneline["hasnewmsgs"] = TRUE; + } + else { + $oneline["hasnewmsgs"] = FALSE; + } + + if (CITADEL_DEBUG_CITPROTO == 1) + { + dbgprintf_wrapout("
", false); + dbgprintf_wrapout(print_r($oneline, true), true); + dbgprintf_wrapout("", false); + + } + $num_lines = array_push($all_lines, $oneline); + } + + return array($num_lines, $all_lines); + +} + +// +// Fetch the list of known floors. +// +/* http://www.citadel.org/doku.php/documentation:appproto:rooms#lflr.list.all.known.floors */ +function ctdl_knfloors() { + global $clientsocket; + + serv_puts("LFLR"); + $response = serv_gets(); + if (substr($response, 0, 1) != "1") { + return array(0, NULL); + } + + $results = read_array(); + $all_lines = array(); + $num_lines = 0; + + foreach ($results as $result){ + $oneline = array(); + $tokens = explode("|",$result); + + $oneline["id"] = $tokens[0]; + $oneline["name"] = $tokens[1]; + $oneline["nref"] = $tokens[2]; + + if (CITADEL_DEBUG_CITPROTO == 1) + { + dbgprintf_wrapout("
", false); + dbgprintf_wrapout(print_r($oneline, true), true); + dbgprintf_wrapout("", false); + } + $num_lines = array_push($all_lines, $oneline); + } + + return array($num_lines, $all_lines); + +} + +/* http://www.citadel.org/doku.php/documentation:appproto:rooms#cflr.create.a.new.floor */ + +// +// Fetch the list of messages in one room. +// Returns: count, response, message array +// +function ctdl_msgs($mode, $count) { + global $clientsocket; + + serv_puts("MSGS " . $mode . "|" . $count); + $responses = read_array(); + dbgprintf_wrapout(print_r($responses, true), false); + + $response = array_shift($responses); + + $num_msgs = count($responses); + if (substr($response, 0, 1) != "1") { + return array(0, substr($response, 4), NULL); + } + + if (CITADEL_DEBUG_CITPROTO == 1) + { + dbgprintf_wrapout("found ".$num_msgs." messages.", true); + } + return array($num_msgs, $response, $responses); +} + + +// Load a message from the server. +function ctdl_fetch_message($msgnum) { + global $clientsocket; + + serv_puts("MSG4 " . $msgnum); + + if (CITADEL_DEBUG_CITPROTO == 1) + dbgprintf_wrapout("