X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=ctdlphp%2Fctdlprotocol.php;h=80b5a3219739f227664bb79942009ca944a0d5e1;hb=fa2dd842abb5feedea3e2253255722fcaecc3c6f;hp=ad7c6707c64ecbba10f7baba7ef5cd6d5fb8d095;hpb=35e102fe570f040ffb392655a7ef9a736d161969;p=citadel.git

diff --git a/ctdlphp/ctdlprotocol.php b/ctdlphp/ctdlprotocol.php
index ad7c6707c..80b5a3219 100644
--- a/ctdlphp/ctdlprotocol.php
+++ b/ctdlphp/ctdlprotocol.php
@@ -6,6 +6,44 @@
 // Copyright (c) 2003 by Art Cancro <ajc@uncensored.citadel.org>
 // One program is released under the terms of the GNU General Public License.
 include "config_ctdlclient.php";
+
+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
 //
@@ -15,14 +53,34 @@ function serv_gets($readblock=FALSE) {
 	$buf = fgets($clientsocket, 4096);		// Read line
 	$buf = substr($buf, 0, (strlen($buf)-1) );	// strip trailing LF
 	if (CITADEL_DEBUG_CITPROTO == 1) {
-		if (!$readblock) printf ("<div class='ctdldbgRead'>");
-		printf($buf);
-		if (!$readblock) printf ("</div>");
-		else printf ("<br>");
+		if (!$readblock) dbgprintf_wrapin("<div class='ctdldbgRead'>\n", false);
+		dbgprintf_wrapin($buf, true);
+		if (!$readblock) dbgprintf_wrapin ("\n</div>\n", false);
+		else dbgprintf_wrapin ("<br>\n", false);
 	}
 	return $buf;
 }
 
+//
+// serv_get_n() -- generic function to read a binary blob from the server
+//
+function serv_get_n($nBytes) {
+	global $clientsocket;
+
+	if (CITADEL_DEBUG_CITPROTO == 1) {
+		dbgprintf_wrapin ("<div class='ctdldbgRead'>\n", false);
+		dbgprintf_wrapin("reading ".$nBytes." bytes from server\n", true);
+		dbgprintf_wrapin ("</div>\n", false);
+	}
+	$buf = fread($clientsocket, $nBytes);
+	if (CITADEL_DEBUG_CITPROTO == 1) {
+		if (!$buf) dbgprintf_wrapin ("<div class='ctdldbgRead'>\n", false);
+		dbgprintf_wrapin($buf, true);
+		if (!$buf) dbgprintf_wrapin ("</div>\n", false);
+		else dbgprintf_wrapin ("<br>\n", false);
+	}
+	return $buf;
+}
 
 //
 // serv_puts() -- generic function to write one line of text to the server
@@ -32,14 +90,18 @@ function serv_puts($buf) {
 	
 	fwrite($clientsocket, $buf . "\n", (strlen($buf)+1) );
 	fflush($clientsocket);
-	if (CITADEL_DEBUG_CITPROTO == 1)
-		printf ("<div class='ctdldbgWrite'>".$buf."</div>");
+	if (CITADEL_DEBUG_CITPROTO == 1) {
+		dbgprintf_wrapin("<div class='ctdldbgWrite'>", false);
+		dbgprintf_wrapin($buf, true);
+		dbgprintf_wrapin("</div>\n", false);
+	}
 }
 
+
 function read_array() {
 	$nLines = 0;
 	if (CITADEL_DEBUG_CITPROTO == 1)
-	    printf ("<div class='ctdldbgRead'>");
+		dbgprintf_wrapout("<div class='ctdldbgRead'>\n", false);
 	$buf = serv_gets(TRUE);
 	$ret = array();
 	while (strcasecmp($buf, "000")){
@@ -48,12 +110,34 @@ function read_array() {
 		$nLines++;
 	}
 	if (CITADEL_DEBUG_CITPROTO == 1){
-		echo "read ".$nLines." lines from the server.";
-		printf ("</div>");
+		dbgprintf_wrapout("read ".$nLines." lines from the server.\n", true);
+		dbgprintf_wrapout ("</div>\n", false);
 	}
 	return $ret;
 }
 
+function read_binary() {
+	$nLines = 0;
+	if (CITADEL_DEBUG_CITPROTO == 1)
+		dbgprintf_wrapout ("<div class='ctdldbgRead'>\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 ("</div>\n", false);
+	return array($statusline, $buf);
+}
+
 
 
 // 
@@ -92,8 +176,14 @@ function text_to_server($thetext, $convert_to_html) {
 
 }
 
+//--------------------------------------------------------------------------------
+//   protocol commands
+//--------------------------------------------------------------------------------
+
+
 //
 // Identify ourselves to the Citadel server (do one once after connection)
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#iden.identify.the.client.software */
 //
 function ctdl_iden($client_info) {
 	global $clientsocket;
@@ -111,6 +201,80 @@ function ctdl_MessageFormatsPrefered($formatlist){
 	$buf = serv_gets();
 }
 
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#noop.no.operation */
+function ctdl_noop(){
+	// Also express our message format preferences
+	serv_puts("NOOP ");
+	$buf = serv_gets();
+}
+
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#quit.quit */
+function ctdl_quit(){
+	// Also express our message format preferences
+	serv_puts("QUIT ");
+	$buf = serv_gets();
+}
+
+
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#mesg.read.system.message */
+function ctdl_gtls(){
+	// Also express our message format preferences
+	serv_puts("GTLS ");
+	$buf = serv_gets();
+	return $buf;
+}
+
+
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#qnop.quiet.no.operation */
+/* this seems to be dangerous. ask IG
+function ctdl_qnoop(){
+	// Also express our message format preferences
+	serv_puts("QNOP ");
+}
+*/
+
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#echo.echo.something */
+function ctdl_doecho($echotext){
+	// Also express our message format preferences
+	serv_puts("ECHO ".$echotext);
+	$buf = serv_gets();
+
+}
+
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#time.get.server.local.time */
+/* TODO: what are the other two params? doku is incomplete here. */
+function ctdl_time(){
+	// Also express our message format preferences
+	serv_puts("TIME");
+	$buf = serv_gets();
+
+}
+
+
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#qdir.query.global.directory */
+function ctdl_qdir($who){
+	// Also express our message format preferences
+	serv_puts("QDIR ".$who);
+	$buf = serv_gets();
+	return array((substr($buf, 0, 1) == "2"), $buf);
+}
+
+
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#auto.autocompletion.of.email.addresses */
+function ctdl_auto($who){
+	// Also express our message format preferences
+	serv_puts("AUTO ".$who);
+	$buf = serv_gets();
+	if (substr($buf, 0, 1) == "1") {
+		$reply = read_array();
+		if (count($reply) == 0)
+			return false;
+		return $reply;
+	}
+	else
+		return false;
+}
+
 
 
 //
@@ -118,13 +282,20 @@ function ctdl_MessageFormatsPrefered($formatlist){
 // Returns an array with two variables:
 // 0. TRUE or FALSE to determine success or failure
 // 1. String error message (if relevant)
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#user.send.user.name */
+/* http://www.citadel.org/doku.php/documentation:appproto:connection#pass.send.password */
+
 //
 function login_existing_user($user, $pass) {
 	global $clientsocket;
 
 	serv_puts("USER " . $user);
 	$resp = serv_gets();
+	
+	if (substr($resp, 0, 3) == 541) // we're already logged in. 
+		return array(TRUE, substr($resp, 4));
 	if (substr($resp, 0, 1) != "3") {
+		
 		return array(FALSE, substr($resp, 4));
 	}
 
@@ -196,11 +367,12 @@ function become_logged_in($server_parms) {
 //
 // 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_serv_info() {
 	serv_puts("INFO");
 	$reply = read_array();
-	if ((count($reply) == 18) &&
+	if ((count($reply) == 23) &&
 	    substr($reply[0], 0, 1) == "1") {
 		$server_info=array();
 		$server_info["serv_nodename"]  = $reply[1];
@@ -211,14 +383,31 @@ function ctdl_get_serv_info() {
 		$server_info["serv_sysadmin"]  = $reply[7];
 		if (CITADEL_DEBUG_CITPROTO == 1)
 		{
-			echo "<pre>";
-			print_r($server_info);
-			echo "</pre>";
+			dbgprintf_wrapout("<pre>", false);
+			dbgprintf_wrapout(print_r($server_info, true), true);
+			dbgprintf_wrapout("</pre>", false);
 		}
 		return $server_info;
 	}
 	else 
-		die ("didn't understand the reply to the INFO command");
+	{
+		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");
 
 }
 
@@ -228,6 +417,7 @@ function ctdl_get_serv_info() {
 // (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;
 
@@ -248,9 +438,44 @@ function ctdl_mesg($msgname) {
 	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 = "<DIV ALIGN=CENTER>\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;
@@ -286,9 +511,9 @@ function ctdl_rwho() {
 		// IGnore the rest of the fields for now.
 		if (CITADEL_DEBUG_CITPROTO == 1)
 		{
-			echo "<pre>";
-			print_r($oneline);
-			echo "</pre>";
+			dbgprintf_wrapout("<pre>", false);
+			dbgprintf_wrapout(print_r($oneline, true), true);
+			dbgprintf_wrapout("</pre>", false);;
 
 		}
 
@@ -336,9 +561,9 @@ function ctdl_goto($to_where) {
 		$_SESSION["room"] = $room;
 		if (CITADEL_DEBUG_CITPROTO == 1)
 		{
-			echo "<pre>";
-			print_r($room_state);
-			echo "</pre>";
+			dbgprintf_wrapout("<pre>", false);
+			dbgprintf_wrapout(print_r($room_state, true), true);
+			dbgprintf_wrapout("</pre>", false);
 
 		}
 
@@ -360,12 +585,11 @@ function ctdl_knrooms() {
 	global $clientsocket;
 
 	serv_puts("LKRA");
-	$results = read_array();
-
-	if (substr($results[0], 0, 1) != "1") {
+	$response = serv_gets();
+	if (substr($response, 0, 1) != "1") {
 		return array(0, NULL);
 	}
-	array_shift($results);
+	$results = read_array();
 	$all_lines = array();
 	$num_lines = 0;
 
@@ -389,10 +613,48 @@ function ctdl_knrooms() {
 
 		if (CITADEL_DEBUG_CITPROTO == 1)
 		{
-			echo "<pre>";
-			print_r($oneline);
-			echo "</pre>";
+			dbgprintf_wrapout("<pre>", false);
+			dbgprintf_wrapout(print_r($oneline, true), true);
+			dbgprintf_wrapout("</pre>", 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("<pre>", false);
+			dbgprintf_wrapout(print_r($oneline, true), true);
+			dbgprintf_wrapout("</pre>", false);
 		}
 		$num_lines = array_push($all_lines, $oneline);
 	}
@@ -401,6 +663,7 @@ function ctdl_knrooms() {
 
 }
 
+/* http://www.citadel.org/doku.php/documentation:appproto:rooms#cflr.create.a.new.floor */
 
 //
 // Fetch the list of messages in one room.
@@ -411,7 +674,7 @@ function ctdl_msgs($mode, $count) {
 
 	serv_puts("MSGS " . $mode . "|" . $count);
 	$responses = read_array();
-	print_r($responses);
+	dbgprintf_wrapout(print_r($responses, true), false);
 
 	$response = array_shift($responses);
 
@@ -422,7 +685,7 @@ function ctdl_msgs($mode, $count) {
 	
 	if (CITADEL_DEBUG_CITPROTO == 1)
 	{
-		printf("found ".$num_msgs." messages.");
+		dbgprintf_wrapout("found ".$num_msgs." messages.", true);
 	}
 	return array($num_msgs, $response, $responses);
 }
@@ -435,7 +698,7 @@ function ctdl_fetch_message($msgnum) {
 	serv_puts("MSG4 " . $msgnum);
 
 	if (CITADEL_DEBUG_CITPROTO == 1)
-	    printf ("<div class='ctdldbgRead'>");
+		dbgprintf_wrapout("<div class='ctdldbgRead'>", false);
 	$response = serv_gets(TRUE);
 
 	if (substr($response, 0, 1) != "1") {
@@ -446,11 +709,13 @@ function ctdl_fetch_message($msgnum) {
 	while (strcmp($buf = serv_gets(TRUE), "000")) {
 		if (substr($buf, 0, 4) == "text") {
 			if (CITADEL_DEBUG_CITPROTO == 1)
-				printf ("</div>\n<h3>Message Body Follows</h3><div class='ctdldbgRead'>");
+				dbgprintf_wrapout("</div>\n<h3>Message Body Follows</h3><div class='ctdldbgRead'>", false);
 			// We're in the text body.  New loop here.
-			$fields["text"] = ctdl_msg4_from_server();
+			$texts = ctdl_msg4_from_server();
+			$fields["text"] = $texts[0];
+			$fields["formated_text"]=$texts[1];
 			if (CITADEL_DEBUG_CITPROTO == 1)
-				printf ("</div>");
+				dbgprintf_wrapout ("</div>", false);
 			return array(TRUE, substr($response, 4), $fields);
 		}
 		else {
@@ -462,12 +727,44 @@ function ctdl_fetch_message($msgnum) {
 	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("<div class='ctdldbgRead'>", 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;
 
@@ -488,7 +785,9 @@ function ctdl_msg4_from_server() {
 				$txt .= $buf;
 			}
 			else if (!strcasecmp($msgformat, "text/plain")) {
-				$txt .= "<TT>" . htmlspecialchars($buf) . "</TT><BR>\n" ;
+				$txt .= "\r\n".$buf;
+				$modified_txt .= "<TT>" . htmlspecialchars($buf) . "</TT><BR>\n" ;
+
 			}
 			else if (!strcasecmp($msgformat, "text/x-citadel-variformat")) {
 				if (substr($previous_line, 0, 1) == " ") {
@@ -503,7 +802,90 @@ function ctdl_msg4_from_server() {
 		}
 	}
 
-	return($txt);
+	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");
 }