X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=ctdlphp%2Fctdlprotocol.php;h=80b5a3219739f227664bb79942009ca944a0d5e1;hb=a5c66770dfd125d3d18bbdd607252604748877f3;hp=84ab12541616d1011cdd819908101b64bb52ab7c;hpb=2642bdc0ac104857a0026d0c9b0b8f271ad4d9a2;p=citadel.git
diff --git a/ctdlphp/ctdlprotocol.php b/ctdlphp/ctdlprotocol.php
index 84ab12541..80b5a3219 100644
--- a/ctdlphp/ctdlprotocol.php
+++ b/ctdlphp/ctdlprotocol.php
@@ -1,52 +1,892 @@
+// One program is released under the terms of the GNU General Public License.
+include "config_ctdlclient.php";
-function serv_gets() {
+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);
+
+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("
\n", false);
+ dbgprintf_wrapin($buf, true);
+ if (!$readblock) dbgprintf_wrapin ("\n
\n", false);
+ else dbgprintf_wrapin ("\n", false);
+ dbgprintf_wrapin("reading ".$nBytes." bytes from server\n", true);
+ dbgprintf_wrapin ("
\n", false);
+ }
+ $buf = fread($clientsocket, $nBytes);
+ if (CITADEL_DEBUG_CITPROTO == 1) {
+ if (!$buf) dbgprintf_wrapin ("\n", false);
+ $buf = serv_gets(TRUE);
+ $ret = array();
+ while (strcasecmp($buf, "000")){
+ array_push($ret, $buf);
+ $buf = serv_gets(TRUE);
+ $nLines++;
+ }
+ if (CITADEL_DEBUG_CITPROTO == 1){
+ dbgprintf_wrapout("read ".$nLines." lines from the server.\n", true);
+ dbgprintf_wrapout ("
\n", false);
+ }
+ return $ret;
+}
+
+function read_binary() {
+ $nLines = 0;
+ if (CITADEL_DEBUG_CITPROTO == 1)
+ dbgprintf_wrapout ("\n", false);
+ $buf = serv_gets(TRUE);
+
+ if (CITADEL_DEBUG_CITPROTO == 1){
+ dbgprintf_wrapout("status line from the server\n", true);
+ }
+
+ $statusline = explode(" ", $buf);
+
+ if ($statusline[0] == 600)
+ {
+ $buf = serv_get_n($statusline[1]);
+
+ }
+ if (CITADEL_DEBUG_CITPROTO == 1)
+ dbgprintf_wrapout ("
\n", false);
+ return array($statusline, $buf);
}
-function test_for_echo() {
+//
+// text_to_server() -- sends a block of text to the server. Assumes that
+// the server just sent back a SEND_LISTING response code
+// and is now expecting a 000-terminated series of lines.
+// Set 'convert_to_html' to TRUE to convert the block of
+// text to HTML along the way.
+//
+function text_to_server($thetext, $convert_to_html) {
- global $clientsocket, $session;
+ // HTML mode
+ if ($convert_to_html) {
- $command = "ECHO Video vertigo ... test for echo.";
+ // Strip CR's; we only want the LF's
+ $thetext = trim($thetext, "\r");
+
+ // Replace hard line breaks with \n";
+
serv_puts("MESG " . $msgname);
+ $response = read_array();
+
+ if (substr($response[0], 0, 1) == "1") {
+ array_shift($response); // throw away the status code.
+ $msgtext .= "" . implode( "
\n" ,$response);
+ }
+ else {
+ $msgtext .= "" . substr($response[0], 4) . "
\n";
+ }
+
+ $msgtext .= "
\n";
+ return($msgtext);
+}
+
+//
+// Delete a Message.
+// http://www.citadel.org/doku.php/documentation:appproto:room_indexes_and_messages#dele.delete.a.message
+
+function ctdl_dele($msgname) {
+ global $clientsocket;
+
+ $msgtext = "\n";
+
+ serv_puts("DELE " . $msgname);
+ $response = serv_gets();
+
+ if (substr($response[0], 0, 1) == "1") {
+ return TRUE;
+ }
+ else {
+ return FALSE;
+ }
+}
+
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#mesg.read.system.message */
+//// TODO: is this still supported?
+function ctdl_mrtg($what) {
+ global $clientsocket;
+
+ serv_puts("MRTG ".$what);
+ $response = serv_gets();
+
+ if (substr($response, 0, 1) != "1") {
+ return array(0, NULL);
+ }
+
+ $responses = read_array();
+ return $responses;
+}
+//
+// Fetch the list of users currently logged in.
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#rwho.read.who.s.online */
+//
+function ctdl_rwho() {
+ global $clientsocket;
+
+ serv_puts("RWHO");
$response = serv_gets();
+
+ if (substr($response, 0, 1) != "1") {
+ return array(0, NULL);
+ }
- if (substr($response, 0, 1) == "1") {
- echo "
\n";
- do {
- $buf = serv_gets();
- if ($buf != "000") {
- echo "", $buf, "
\n" ;
- }
- } while ($buf != "000");
- echo "
\n";
+ $all_lines = array();
+ $num_lines = 0;
+
+ $responses = read_array();
+ foreach ($responses as $response) {
+ $tokens = explode("|", $response);
+ $oneline = array();
+
+ $oneline["session"] = $tokens[0];
+ $oneline["user"] = $tokens[1];
+ $oneline["room"] = $tokens[2];
+ $oneline["host"] = $tokens[3];
+ $oneline["client"] = $tokens[4];
+ $oneline["idlesince"] = $tokens[5];
+ $oneline["lastcmd"] = $tokens[6];
+ $oneline["flags"] = $tokens[7];
+ $oneline["realname"] = $tokens[8];
+ $oneline["realroom"] = $tokens[9];
+ $oneline["realhostname"] = $tokens[10];
+ $oneline["registered"] = $tokens[11];
+
+ // IGnore the rest of the fields for now.
+ 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);
+
+}
+
+
+//
+// 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 {
- echo "
", substr($response, 4), "\n";
+ 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("
", false);
+ $response = serv_gets(TRUE);
+
+ if (substr($response, 0, 1) != "1") {
+ return array(FALSE, substr($response, 4), NULL);
+ }
+
+ $fields = array();
+ while (strcmp($buf = serv_gets(TRUE), "000")) {
+ if (substr($buf, 0, 4) == "text") {
+ if (CITADEL_DEBUG_CITPROTO == 1)
+ dbgprintf_wrapout("
\n
Message Body Follows
", false);
+ // We're in the text body. New loop here.
+ $texts = ctdl_msg4_from_server();
+ $fields["text"] = $texts[0];
+ $fields["formated_text"]=$texts[1];
+ if (CITADEL_DEBUG_CITPROTO == 1)
+ dbgprintf_wrapout ("
", false);
+ return array(TRUE, substr($response, 4), $fields);
+ }
+ else {
+ $fields[substr($buf, 0, 4)] = substr($buf, 5);
+ }
+ }
+
+ // Message terminated prematurely (no text body)
+ return array(FALSE, substr($response, 4), $fields);
+}
+
+// Load a message from the server.
+function ctdl_fetch_message_rfc822($msgnum) {
+ global $clientsocket;
+
+ serv_puts("MSG2 " . $msgnum);
+
+ if (CITADEL_DEBUG_CITPROTO == 1)
+ dbgprintf_wrapout("
", false);
+ $response = serv_gets(TRUE);
+
+ if (substr($response, 0, 1) != "1") {
+ return array(FALSE, NULL);
+ }
+ $message = "";
+ $buf="";
+ while ($buf = serv_gets(TRUE)) {
+// dbgprintf_wrapout($buf, true);
+ if ($buf=="000")
+ {
+ $message .= "\n.\n";
+ break;
+ }
+ $message = $message . "\n" . $buf;
+ $buf = "";
}
+
+// dbgprintf_wrapout($message, true);
+ // Message terminated prematurely (no text body)
+ return array(TRUE, $message);
}
+// Support function for ctdl_fetch_message(). This handles the text body
+// portion of the message, converting various formats to HTML as
+// appropriate.
+function ctdl_msg4_from_server() {
+
+ $txt = "";
+ $modified_txt = "";
+ $msgformat = "text/plain";
+ $in_body = FALSE;
+
+ $previous_line = "";
+ while (strcmp($buf = serv_gets(TRUE), "000")) {
+ if ($in_body == FALSE) {
+ if (strlen($buf) == 0) {
+ $in_body = TRUE;
+ }
+ else {
+ if (!strncasecmp($buf, "content-type: ", 14)) {
+ $msgformat = substr($buf, 14);
+ }
+ }
+ }
+ else {
+ if (!strcasecmp($msgformat, "text/html")) {
+ $txt .= $buf;
+ }
+ else if (!strcasecmp($msgformat, "text/plain")) {
+ $txt .= "\r\n".$buf;
+ $modified_txt .= "" . htmlspecialchars($buf) . "
\n" ;
+
+ }
+ else if (!strcasecmp($msgformat, "text/x-citadel-variformat")) {
+ if (substr($previous_line, 0, 1) == " ") {
+ $txt .= "
\n" ;
+ }
+ $txt .= htmlspecialchars($buf);
+ }
+ else {
+ $txt .= htmlspecialchars($buf);
+ }
+ $previous_line = $buf;
+ }
+ }
+
+ return(array($txt, $modified_txt));
+}
+
+
+
+function download_attachment($msgnum, $attindex)
+{
+ $command = "DLAT ".$msgnum."|".$attindex;
+ serv_puts($command);
+ $reply = read_binary();
+ return $reply;
+
+}
+
+
+function enter_message_0($msgHdr, $contentType, $data)
+{
+ $send = array();
+
+ if (isset($msgHdr['newusermail']))
+ array_unshift($send, $msgHdr['newusermail']);
+ else
+ array_unshift($send, "");
+
+ if (isset($msgHdr['supplied_euid']))
+ array_unshift($send, $msgHdr['supplied_euid']);
+ else
+ array_unshift($send, "");
+
+ if (isset($msgHdr['bcc']))
+ array_unshift($send, $msgHdr['bcc']);
+ else
+ array_unshift($send, "");
+
+ if (isset($msgHdr['cc']))
+ array_unshift($send, $msgHdr['cc']);
+ else
+ array_unshift($send, "");
+
+ if (isset($msgHdr['do_confirm']))
+ array_unshift($send, $msgHdr['do_confirm']);
+ else
+ array_unshift($send, "");
+
+ if (isset($msgHdr['newusername']))
+ array_unshift($send, $msgHdr['newusername']);
+ else
+ array_unshift($send, "");
+
+ if (isset($msgHdr['subject']))
+ array_unshift($send, $msgHdr['subject']);
+ else
+ array_unshift($send, "");
+
+ if (isset($msgHdr['format_type']))
+ array_unshift($send, $msgHdr['format_type']);
+ else
+ array_unshift($send, "");
+
+ if (isset($msgHdr['anon_flag']))
+ array_unshift($send, $msgHdr['anon_flag']);
+ else
+ array_unshift($send, "");
+
+ if (isset($msgHdr['recp']))
+ array_unshift($send, $msgHdr['recp']);
+ else
+ array_unshift($send, "");
+
+ if (isset($msgHdr['post']))
+ array_unshift($send, $msgHdr['post']);
+ else
+ array_unshift($send, "");
+
+ $params = implode('|', $send);
+ serv_puts("ENT0 ".$params);
+
+ $reply=serv_gets();
+ if (substr($reply, 0, 1) != 4)
+ return array(false, array(), array());
+ serv_puts("Content-type: ".$contentType);
+ serv_puts("");
+ serv_puts($data."\r\n");
+ serv_puts("000");
+}
+
+
?>