xpressengine / xe-core

libs/phpmailer/smtp.php

Doc Comments +7 added lines

@@ -107,6 +107,7 @@ 
    * SMTP CODE SUCCESS: 220
    * SMTP CODE FAILURE: 421
    * @access public
+   * @param string $host
    * @return bool
    */
   public function Connect($host,$port=0,$tval=30) {
@@ -205,6 +206,8 @@ 
    * Performs SMTP authentication.  Must be run after running the
    * Hello() method.  Returns true if successfully authenticated.
    * @access public
+   * @param string $username
+   * @param string $password
    * @return bool
    */
   public function Authenticate($username, $password) {
@@ -321,6 +324,7 @@ 
    * SMTP CODE FAILURE: 451,554
    * SMTP CODE ERROR  : 500,501,503,421
    * @access public
+   * @param string $msg_data
    * @return bool
    */
   public function Data($msg_data) {
@@ -489,6 +493,8 @@ 
   /**
    * Sends a HELO/EHLO command.
    * @access private
+   * @param string $hello
+   * @param string $host
    * @return bool
    */
   private function SendHello($hello, $host) {
@@ -529,6 +535,7 @@ 
    * SMTP CODE SUCCESS: 552,451,452
    * SMTP CODE SUCCESS: 500,501,421
    * @access public
+   * @param string $from
    * @return bool
    */
   public function Mail($from) {

Indentation +470 added lines, -470 removed lines

@@ -85,11 +85,11 @@ 
    * @return void
    */
   public function __construct() {
-    $this->smtp_conn = 0;
-    $this->error = null;
-    $this->helo_rply = null;
+	$this->smtp_conn = 0;
+	$this->error = null;
+	$this->helo_rply = null;
 
-    $this->do_debug = 0;
+	$this->do_debug = 0;
   }
 
   /////////////////////////////////////////////////
@@ -110,50 +110,50 @@ 
    * @return bool
    */
   public function Connect($host,$port=0,$tval=30) {
-    // set the error val to null so there is no confusion
-    $this->error = null;
-
-    // make sure we are __not__ connected
-    if($this->connected()) {
-      // already connected, generate error
-      $this->error = array("error" => "Already connected to a server");
-      return false;
-    }
-
-    if(empty($port)) {
-      $port = $this->SMTP_PORT;
-    }
-
-    // connect to the smtp server
-    $this->smtp_conn = @fsockopen($host,    // the host of the server
-                                 $port,    // the port to use
-                                 $errno,   // error number if any
-                                 $errstr,  // error message if any
-                                 $tval);   // give up after ? secs
-    // verify we connected properly
-    if(empty($this->smtp_conn)) {
-      $this->error = array("error" => "Failed to connect to server",
-                           "errno" => $errno,
-                           "errstr" => $errstr);
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": $errstr ($errno)" . $this->CRLF . '<br />';
-      }
-      return false;
-    }
-
-    // SMTP server can take longer to respond, give longer timeout for first read
-    // Windows does not have support for this timeout function
-    if(substr(PHP_OS, 0, 3) != "WIN")
-     socket_set_timeout($this->smtp_conn, $tval, 0);
-
-    // get any announcement
-    $announce = $this->get_lines();
-
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $announce . $this->CRLF . '<br />';
-    }
-
-    return true;
+	// set the error val to null so there is no confusion
+	$this->error = null;
+
+	// make sure we are __not__ connected
+	if($this->connected()) {
+	  // already connected, generate error
+	  $this->error = array("error" => "Already connected to a server");
+	  return false;
+	}
+
+	if(empty($port)) {
+	  $port = $this->SMTP_PORT;
+	}
+
+	// connect to the smtp server
+	$this->smtp_conn = @fsockopen($host,    // the host of the server
+								 $port,    // the port to use
+								 $errno,   // error number if any
+								 $errstr,  // error message if any
+								 $tval);   // give up after ? secs
+	// verify we connected properly
+	if(empty($this->smtp_conn)) {
+	  $this->error = array("error" => "Failed to connect to server",
+						   "errno" => $errno,
+						   "errstr" => $errstr);
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": $errstr ($errno)" . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
+
+	// SMTP server can take longer to respond, give longer timeout for first read
+	// Windows does not have support for this timeout function
+	if(substr(PHP_OS, 0, 3) != "WIN")
+	 socket_set_timeout($this->smtp_conn, $tval, 0);
+
+	// get any announcement
+	$announce = $this->get_lines();
+
+	if($this->do_debug >= 2) {
+	  echo "SMTP -> FROM SERVER:" . $announce . $this->CRLF . '<br />';
+	}
+
+	return true;
   }
 
   /**
@@ -166,39 +166,39 @@ 
    * @return bool success
    */
   public function StartTLS() {
-    $this->error = null; # to avoid confusion
-
-    if(!$this->connected()) {
-      $this->error = array("error" => "Called StartTLS() without being connected");
-      return false;
-    }
-
-    fputs($this->smtp_conn,"STARTTLS" . $this->CRLF);
-
-    $rply = $this->get_lines();
-    $code = substr($rply,0,3);
-
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
-    }
-
-    if($code != 220) {
-      $this->error =
-         array("error"     => "STARTTLS not accepted from server",
-               "smtp_code" => $code,
-               "smtp_msg"  => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
-      }
-      return false;
-    }
-
-    //Begin encrypted connection
-    if(!stream_socket_enable_crypto($this->smtp_conn, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
-      return false;
-    }
-
-    return true;
+	$this->error = null; # to avoid confusion
+
+	if(!$this->connected()) {
+	  $this->error = array("error" => "Called StartTLS() without being connected");
+	  return false;
+	}
+
+	fputs($this->smtp_conn,"STARTTLS" . $this->CRLF);
+
+	$rply = $this->get_lines();
+	$code = substr($rply,0,3);
+
+	if($this->do_debug >= 2) {
+	  echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+	}
+
+	if($code != 220) {
+	  $this->error =
+		 array("error"     => "STARTTLS not accepted from server",
+			   "smtp_code" => $code,
+			   "smtp_msg"  => substr($rply,4));
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
+
+	//Begin encrypted connection
+	if(!stream_socket_enable_crypto($this->smtp_conn, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
+	  return false;
+	}
+
+	return true;
   }
 
   /**
@@ -208,58 +208,58 @@ 
    * @return bool
    */
   public function Authenticate($username, $password) {
-    // Start authentication
-    fputs($this->smtp_conn,"AUTH LOGIN" . $this->CRLF);
-
-    $rply = $this->get_lines();
-    $code = substr($rply,0,3);
-
-    if($code != 334) {
-      $this->error =
-        array("error" => "AUTH not accepted from server",
-              "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
-      }
-      return false;
-    }
-
-    // Send encoded username
-    fputs($this->smtp_conn, base64_encode($username) . $this->CRLF);
-
-    $rply = $this->get_lines();
-    $code = substr($rply,0,3);
-
-    if($code != 334) {
-      $this->error =
-        array("error" => "Username not accepted from server",
-              "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
-      }
-      return false;
-    }
-
-    // Send encoded password
-    fputs($this->smtp_conn, base64_encode($password) . $this->CRLF);
-
-    $rply = $this->get_lines();
-    $code = substr($rply,0,3);
-
-    if($code != 235) {
-      $this->error =
-        array("error" => "Password not accepted from server",
-              "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
-      }
-      return false;
-    }
-
-    return true;
+	// Start authentication
+	fputs($this->smtp_conn,"AUTH LOGIN" . $this->CRLF);
+
+	$rply = $this->get_lines();
+	$code = substr($rply,0,3);
+
+	if($code != 334) {
+	  $this->error =
+		array("error" => "AUTH not accepted from server",
+			  "smtp_code" => $code,
+			  "smtp_msg" => substr($rply,4));
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
+
+	// Send encoded username
+	fputs($this->smtp_conn, base64_encode($username) . $this->CRLF);
+
+	$rply = $this->get_lines();
+	$code = substr($rply,0,3);
+
+	if($code != 334) {
+	  $this->error =
+		array("error" => "Username not accepted from server",
+			  "smtp_code" => $code,
+			  "smtp_msg" => substr($rply,4));
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
+
+	// Send encoded password
+	fputs($this->smtp_conn, base64_encode($password) . $this->CRLF);
+
+	$rply = $this->get_lines();
+	$code = substr($rply,0,3);
+
+	if($code != 235) {
+	  $this->error =
+		array("error" => "Password not accepted from server",
+			  "smtp_code" => $code,
+			  "smtp_msg" => substr($rply,4));
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
+
+	return true;
   }
 
   /**
@@ -268,19 +268,19 @@ 
    * @return bool
    */
   public function Connected() {
-    if(!empty($this->smtp_conn)) {
-      $sock_status = socket_get_status($this->smtp_conn);
-      if($sock_status["eof"]) {
-        // the socket is valid but we are not connected
-        if($this->do_debug >= 1) {
-            echo "SMTP -> NOTICE:" . $this->CRLF . "EOF caught while checking if connected";
-        }
-        $this->Close();
-        return false;
-      }
-      return true; // everything looks good
-    }
-    return false;
+	if(!empty($this->smtp_conn)) {
+	  $sock_status = socket_get_status($this->smtp_conn);
+	  if($sock_status["eof"]) {
+		// the socket is valid but we are not connected
+		if($this->do_debug >= 1) {
+			echo "SMTP -> NOTICE:" . $this->CRLF . "EOF caught while checking if connected";
+		}
+		$this->Close();
+		return false;
+	  }
+	  return true; // everything looks good
+	}
+	return false;
   }
 
   /**
@@ -291,13 +291,13 @@ 
    * @return void
    */
   public function Close() {
-    $this->error = null; // so there is no confusion
-    $this->helo_rply = null;
-    if(!empty($this->smtp_conn)) {
-      // close the connection and cleanup
-      fclose($this->smtp_conn);
-      $this->smtp_conn = 0;
-    }
+	$this->error = null; // so there is no confusion
+	$this->helo_rply = null;
+	if(!empty($this->smtp_conn)) {
+	  // close the connection and cleanup
+	  fclose($this->smtp_conn);
+	  $this->smtp_conn = 0;
+	}
   }
 
   /////////////////////////////////////////////////
@@ -324,35 +324,35 @@ 
    * @return bool
    */
   public function Data($msg_data) {
-    $this->error = null; // so no confusion is caused
-
-    if(!$this->connected()) {
-      $this->error = array(
-              "error" => "Called Data() without being connected");
-      return false;
-    }
-
-    fputs($this->smtp_conn,"DATA" . $this->CRLF);
-
-    $rply = $this->get_lines();
-    $code = substr($rply,0,3);
-
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
-    }
-
-    if($code != 354) {
-      $this->error =
-        array("error" => "DATA command not accepted from server",
-              "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
-      }
-      return false;
-    }
-
-    /* the server is ready to accept data!
+	$this->error = null; // so no confusion is caused
+
+	if(!$this->connected()) {
+	  $this->error = array(
+			  "error" => "Called Data() without being connected");
+	  return false;
+	}
+
+	fputs($this->smtp_conn,"DATA" . $this->CRLF);
+
+	$rply = $this->get_lines();
+	$code = substr($rply,0,3);
+
+	if($this->do_debug >= 2) {
+	  echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+	}
+
+	if($code != 354) {
+	  $this->error =
+		array("error" => "DATA command not accepted from server",
+			  "smtp_code" => $code,
+			  "smtp_msg" => substr($rply,4));
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
+
+	/* the server is ready to accept data!
      * according to rfc 821 we should not send more than 1000
      * including the CRLF
      * characters on a single line so we will break the data up
@@ -363,12 +363,12 @@ 
      * line. NOTE: this does not count towards limit.
      */
 
-    // normalize the line breaks so we know the explode works
-    $msg_data = str_replace("\r\n","\n",$msg_data);
-    $msg_data = str_replace("\r","\n",$msg_data);
-    $lines = explode("\n",$msg_data);
+	// normalize the line breaks so we know the explode works
+	$msg_data = str_replace("\r\n","\n",$msg_data);
+	$msg_data = str_replace("\r","\n",$msg_data);
+	$lines = explode("\n",$msg_data);
 
-    /* we need to find a good way to determine is headers are
+	/* we need to find a good way to determine is headers are
      * in the msg_data or if it is a straight msg body
      * currently I am assuming rfc 822 definitions of msg headers
      * and if the first field of the first line (':' sperated)
@@ -377,76 +377,76 @@ 
      * headers.
      */
 
-    $field = substr($lines[0],0,strpos($lines[0],":"));
-    $in_headers = false;
-    if(!empty($field) && !strstr($field," ")) {
-      $in_headers = true;
-    }
-
-    $max_line_length = 998; // used below; set here for ease in change
-
-    while(list(,$line) = @each($lines)) {
-      $lines_out = null;
-      if($line == "" && $in_headers) {
-        $in_headers = false;
-      }
-      // ok we need to break this line up into several smaller lines
-      while(strlen($line) > $max_line_length) {
-        $pos = strrpos(substr($line,0,$max_line_length)," ");
-
-        // Patch to fix DOS attack
-        if(!$pos) {
-          $pos = $max_line_length - 1;
-          $lines_out[] = substr($line,0,$pos);
-          $line = substr($line,$pos);
-        } else {
-          $lines_out[] = substr($line,0,$pos);
-          $line = substr($line,$pos + 1);
-        }
-
-        /* if we are processing headers we need to
+	$field = substr($lines[0],0,strpos($lines[0],":"));
+	$in_headers = false;
+	if(!empty($field) && !strstr($field," ")) {
+	  $in_headers = true;
+	}
+
+	$max_line_length = 998; // used below; set here for ease in change
+
+	while(list(,$line) = @each($lines)) {
+	  $lines_out = null;
+	  if($line == "" && $in_headers) {
+		$in_headers = false;
+	  }
+	  // ok we need to break this line up into several smaller lines
+	  while(strlen($line) > $max_line_length) {
+		$pos = strrpos(substr($line,0,$max_line_length)," ");
+
+		// Patch to fix DOS attack
+		if(!$pos) {
+		  $pos = $max_line_length - 1;
+		  $lines_out[] = substr($line,0,$pos);
+		  $line = substr($line,$pos);
+		} else {
+		  $lines_out[] = substr($line,0,$pos);
+		  $line = substr($line,$pos + 1);
+		}
+
+		/* if we are processing headers we need to
          * add a LWSP-char to the front of the new line
          * rfc 822 on long msg headers
          */
-        if($in_headers) {
-          $line = "\t" . $line;
-        }
-      }
-      $lines_out[] = $line;
-
-      // send the lines to the server
-      while(list(,$line_out) = @each($lines_out)) {
-        if(strlen($line_out) > 0)
-        {
-          if(substr($line_out, 0, 1) == ".") {
-            $line_out = "." . $line_out;
-          }
-        }
-        fputs($this->smtp_conn,$line_out . $this->CRLF);
-      }
-    }
-
-    // message data has been sent
-    fputs($this->smtp_conn, $this->CRLF . "." . $this->CRLF);
-
-    $rply = $this->get_lines();
-    $code = substr($rply,0,3);
-
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
-    }
-
-    if($code != 250) {
-      $this->error =
-        array("error" => "DATA not accepted from server",
-              "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
-      }
-      return false;
-    }
-    return true;
+		if($in_headers) {
+		  $line = "\t" . $line;
+		}
+	  }
+	  $lines_out[] = $line;
+
+	  // send the lines to the server
+	  while(list(,$line_out) = @each($lines_out)) {
+		if(strlen($line_out) > 0)
+		{
+		  if(substr($line_out, 0, 1) == ".") {
+			$line_out = "." . $line_out;
+		  }
+		}
+		fputs($this->smtp_conn,$line_out . $this->CRLF);
+	  }
+	}
+
+	// message data has been sent
+	fputs($this->smtp_conn, $this->CRLF . "." . $this->CRLF);
+
+	$rply = $this->get_lines();
+	$code = substr($rply,0,3);
+
+	if($this->do_debug >= 2) {
+	  echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+	}
+
+	if($code != 250) {
+	  $this->error =
+		array("error" => "DATA not accepted from server",
+			  "smtp_code" => $code,
+			  "smtp_msg" => substr($rply,4));
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
+	return true;
   }
 
   /**
@@ -462,28 +462,28 @@ 
    * @return bool
    */
   public function Hello($host = '') {
-    $this->error = null; // so no confusion is caused
-
-    if(!$this->connected()) {
-      $this->error = array(
-            "error" => "Called Hello() without being connected");
-      return false;
-    }
-
-    // if hostname for HELO was not specified send default
-    if(empty($host)) {
-      // determine appropriate default to send to server
-      $host = "localhost";
-    }
-
-    // Send extended hello first (RFC 2821)
-    if(!$this->SendHello("EHLO", $host)) {
-      if(!$this->SendHello("HELO", $host)) {
-          return false;
-    }
-    }
-
-    return true;
+	$this->error = null; // so no confusion is caused
+
+	if(!$this->connected()) {
+	  $this->error = array(
+			"error" => "Called Hello() without being connected");
+	  return false;
+	}
+
+	// if hostname for HELO was not specified send default
+	if(empty($host)) {
+	  // determine appropriate default to send to server
+	  $host = "localhost";
+	}
+
+	// Send extended hello first (RFC 2821)
+	if(!$this->SendHello("EHLO", $host)) {
+	  if(!$this->SendHello("HELO", $host)) {
+		  return false;
+	}
+	}
+
+	return true;
   }
 
   /**
@@ -492,29 +492,29 @@ 
    * @return bool
    */
   private function SendHello($hello, $host) {
-    fputs($this->smtp_conn, $hello . " " . $host . $this->CRLF);
+	fputs($this->smtp_conn, $hello . " " . $host . $this->CRLF);
 
-    $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+	$rply = $this->get_lines();
+	$code = substr($rply,0,3);
 
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER: " . $rply . $this->CRLF . '<br />';
-    }
+	if($this->do_debug >= 2) {
+	  echo "SMTP -> FROM SERVER: " . $rply . $this->CRLF . '<br />';
+	}
 
-    if($code != 250) {
-      $this->error =
-        array("error" => $hello . " not accepted from server",
-              "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
-      }
-      return false;
-    }
+	if($code != 250) {
+	  $this->error =
+		array("error" => $hello . " not accepted from server",
+			  "smtp_code" => $code,
+			  "smtp_msg" => substr($rply,4));
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
 
-    $this->helo_rply = $rply;
+	$this->helo_rply = $rply;
 
-    return true;
+	return true;
   }
 
   /**
@@ -532,35 +532,35 @@ 
    * @return bool
    */
   public function Mail($from) {
-    $this->error = null; // so no confusion is caused
-
-    if(!$this->connected()) {
-      $this->error = array(
-              "error" => "Called Mail() without being connected");
-      return false;
-    }
-
-    $useVerp = ($this->do_verp ? "XVERP" : "");
-    fputs($this->smtp_conn,"MAIL FROM:<" . $from . ">" . $useVerp . $this->CRLF);
-
-    $rply = $this->get_lines();
-    $code = substr($rply,0,3);
-
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
-    }
-
-    if($code != 250) {
-      $this->error =
-        array("error" => "MAIL not accepted from server",
-              "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
-      }
-      return false;
-    }
-    return true;
+	$this->error = null; // so no confusion is caused
+
+	if(!$this->connected()) {
+	  $this->error = array(
+			  "error" => "Called Mail() without being connected");
+	  return false;
+	}
+
+	$useVerp = ($this->do_verp ? "XVERP" : "");
+	fputs($this->smtp_conn,"MAIL FROM:<" . $from . ">" . $useVerp . $this->CRLF);
+
+	$rply = $this->get_lines();
+	$code = substr($rply,0,3);
+
+	if($this->do_debug >= 2) {
+	  echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+	}
+
+	if($code != 250) {
+	  $this->error =
+		array("error" => "MAIL not accepted from server",
+			  "smtp_code" => $code,
+			  "smtp_msg" => substr($rply,4));
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
+	return true;
   }
 
   /**
@@ -575,44 +575,44 @@ 
    * @return bool
    */
   public function Quit($close_on_error=true) {
-    $this->error = null; // so there is no confusion
-
-    if(!$this->connected()) {
-      $this->error = array(
-              "error" => "Called Quit() without being connected");
-      return false;
-    }
-
-    // send the quit command to the server
-    fputs($this->smtp_conn,"quit" . $this->CRLF);
-
-    // get any good-bye messages
-    $byemsg = $this->get_lines();
-
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $byemsg . $this->CRLF . '<br />';
-    }
-
-    $rval = true;
-    $e = null;
-
-    $code = substr($byemsg,0,3);
-    if($code != 221) {
-      // use e as a tmp var cause Close will overwrite $this->error
-      $e = array("error" => "SMTP server rejected quit command",
-                 "smtp_code" => $code,
-                 "smtp_rply" => substr($byemsg,4));
-      $rval = false;
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $e["error"] . ": " . $byemsg . $this->CRLF . '<br />';
-      }
-    }
-
-    if(empty($e) || $close_on_error) {
-      $this->Close();
-    }
-
-    return $rval;
+	$this->error = null; // so there is no confusion
+
+	if(!$this->connected()) {
+	  $this->error = array(
+			  "error" => "Called Quit() without being connected");
+	  return false;
+	}
+
+	// send the quit command to the server
+	fputs($this->smtp_conn,"quit" . $this->CRLF);
+
+	// get any good-bye messages
+	$byemsg = $this->get_lines();
+
+	if($this->do_debug >= 2) {
+	  echo "SMTP -> FROM SERVER:" . $byemsg . $this->CRLF . '<br />';
+	}
+
+	$rval = true;
+	$e = null;
+
+	$code = substr($byemsg,0,3);
+	if($code != 221) {
+	  // use e as a tmp var cause Close will overwrite $this->error
+	  $e = array("error" => "SMTP server rejected quit command",
+				 "smtp_code" => $code,
+				 "smtp_rply" => substr($byemsg,4));
+	  $rval = false;
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $e["error"] . ": " . $byemsg . $this->CRLF . '<br />';
+	  }
+	}
+
+	if(empty($e) || $close_on_error) {
+	  $this->Close();
+	}
+
+	return $rval;
   }
 
   /**
@@ -628,34 +628,34 @@ 
    * @return bool
    */
   public function Recipient($to) {
-    $this->error = null; // so no confusion is caused
-
-    if(!$this->connected()) {
-      $this->error = array(
-              "error" => "Called Recipient() without being connected");
-      return false;
-    }
-
-    fputs($this->smtp_conn,"RCPT TO:<" . $to . ">" . $this->CRLF);
-
-    $rply = $this->get_lines();
-    $code = substr($rply,0,3);
-
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
-    }
-
-    if($code != 250 && $code != 251) {
-      $this->error =
-        array("error" => "RCPT not accepted from server",
-              "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
-      }
-      return false;
-    }
-    return true;
+	$this->error = null; // so no confusion is caused
+
+	if(!$this->connected()) {
+	  $this->error = array(
+			  "error" => "Called Recipient() without being connected");
+	  return false;
+	}
+
+	fputs($this->smtp_conn,"RCPT TO:<" . $to . ">" . $this->CRLF);
+
+	$rply = $this->get_lines();
+	$code = substr($rply,0,3);
+
+	if($this->do_debug >= 2) {
+	  echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+	}
+
+	if($code != 250 && $code != 251) {
+	  $this->error =
+		array("error" => "RCPT not accepted from server",
+			  "smtp_code" => $code,
+			  "smtp_msg" => substr($rply,4));
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
+	return true;
   }
 
   /**
@@ -671,35 +671,35 @@ 
    * @return bool
    */
   public function Reset() {
-    $this->error = null; // so no confusion is caused
-
-    if(!$this->connected()) {
-      $this->error = array(
-              "error" => "Called Reset() without being connected");
-      return false;
-    }
-
-    fputs($this->smtp_conn,"RSET" . $this->CRLF);
-
-    $rply = $this->get_lines();
-    $code = substr($rply,0,3);
-
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
-    }
-
-    if($code != 250) {
-      $this->error =
-        array("error" => "RSET failed",
-              "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
-      }
-      return false;
-    }
-
-    return true;
+	$this->error = null; // so no confusion is caused
+
+	if(!$this->connected()) {
+	  $this->error = array(
+			  "error" => "Called Reset() without being connected");
+	  return false;
+	}
+
+	fputs($this->smtp_conn,"RSET" . $this->CRLF);
+
+	$rply = $this->get_lines();
+	$code = substr($rply,0,3);
+
+	if($this->do_debug >= 2) {
+	  echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+	}
+
+	if($code != 250) {
+	  $this->error =
+		array("error" => "RSET failed",
+			  "smtp_code" => $code,
+			  "smtp_msg" => substr($rply,4));
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
+
+	return true;
   }
 
   /**
@@ -719,34 +719,34 @@ 
    * @return bool
    */
   public function SendAndMail($from) {
-    $this->error = null; // so no confusion is caused
-
-    if(!$this->connected()) {
-      $this->error = array(
-          "error" => "Called SendAndMail() without being connected");
-      return false;
-    }
-
-    fputs($this->smtp_conn,"SAML FROM:" . $from . $this->CRLF);
-
-    $rply = $this->get_lines();
-    $code = substr($rply,0,3);
-
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
-    }
-
-    if($code != 250) {
-      $this->error =
-        array("error" => "SAML not accepted from server",
-              "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
-      }
-      return false;
-    }
-    return true;
+	$this->error = null; // so no confusion is caused
+
+	if(!$this->connected()) {
+	  $this->error = array(
+		  "error" => "Called SendAndMail() without being connected");
+	  return false;
+	}
+
+	fputs($this->smtp_conn,"SAML FROM:" . $from . $this->CRLF);
+
+	$rply = $this->get_lines();
+	$code = substr($rply,0,3);
+
+	if($this->do_debug >= 2) {
+	  echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+	}
+
+	if($code != 250) {
+	  $this->error =
+		array("error" => "SAML not accepted from server",
+			  "smtp_code" => $code,
+			  "smtp_msg" => substr($rply,4));
+	  if($this->do_debug >= 1) {
+		echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+	  }
+	  return false;
+	}
+	return true;
   }
 
   /**
@@ -763,22 +763,22 @@ 
    * @return bool
    */
   public function Turn() {
-    $this->error = array("error" => "This method, TURN, of the SMTP ".
-                                    "is not implemented");
-    if($this->do_debug >= 1) {
-      echo "SMTP -> NOTICE: " . $this->error["error"] . $this->CRLF . '<br />';
-    }
-    return false;
+	$this->error = array("error" => "This method, TURN, of the SMTP ".
+									"is not implemented");
+	if($this->do_debug >= 1) {
+	  echo "SMTP -> NOTICE: " . $this->error["error"] . $this->CRLF . '<br />';
+	}
+	return false;
   }
 
   /**
-  * Get the current error
+   * Get the current error
    * @access public
-  * @return array
+   * @return array
    */
   public function getError() {
-    return $this->error;
-    }
+	return $this->error;
+	}
 
   /////////////////////////////////////////////////
   // INTERNAL FUNCTIONS
@@ -794,20 +794,20 @@ 
    * @return string
    */
   private function get_lines() {
-    $data = "";
-    while($str = @fgets($this->smtp_conn,515)) {
-      if($this->do_debug >= 4) {
-        echo "SMTP -> get_lines(): \$data was \"$data\"" . $this->CRLF . '<br />';
-        echo "SMTP -> get_lines(): \$str is \"$str\"" . $this->CRLF . '<br />';
-      }
-      $data .= $str;
-      if($this->do_debug >= 4) {
-        echo "SMTP -> get_lines(): \$data is \"$data\"" . $this->CRLF . '<br />';
-      }
-      // if 4th character is a space, we are done reading, break the loop
-      if(substr($str,3,1) == " ") { break; }
-    }
-    return $data;
+	$data = "";
+	while($str = @fgets($this->smtp_conn,515)) {
+	  if($this->do_debug >= 4) {
+		echo "SMTP -> get_lines(): \$data was \"$data\"" . $this->CRLF . '<br />';
+		echo "SMTP -> get_lines(): \$str is \"$str\"" . $this->CRLF . '<br />';
+	  }
+	  $data .= $str;
+	  if($this->do_debug >= 4) {
+		echo "SMTP -> get_lines(): \$data is \"$data\"" . $this->CRLF . '<br />';
+	  }
+	  // if 4th character is a space, we are done reading, break the loop
+	  if(substr($str,3,1) == " ") { break; }
+	}
+	return $data;
   }
 
 }

Braces +3 added lines, -2 removed lines

@@ -143,8 +143,9 @@
 
     // SMTP server can take longer to respond, give longer timeout for first read
     // Windows does not have support for this timeout function
-    if(substr(PHP_OS, 0, 3) != "WIN")
-     socket_set_timeout($this->smtp_conn, $tval, 0);
+    if(substr(PHP_OS, 0, 3) != "WIN") {
+         socket_set_timeout($this->smtp_conn, $tval, 0);
+    }
 
     // get any announcement
     $announce = $this->get_lines();

Spacing +158 added lines, -158 removed lines

@@ -63,7 +63,7 @@ 
    *  Sets whether debugging is turned on
    *  @var bool
    */
-  public $do_debug;       // the level of debug to perform
+  public $do_debug; // the level of debug to perform
 
   /**
    *  Sets VERP use on/off (default is off)
@@ -75,9 +75,9 @@ 
   // PROPERTIES, PRIVATE AND PROTECTED
   /////////////////////////////////////////////////
 
-  private $smtp_conn;      // the socket to the server
-  private $error;          // error if any on the last call
-  private $helo_rply;      // the reply the server sent to us for HELO
+  private $smtp_conn; // the socket to the server
+  private $error; // error if any on the last call
+  private $helo_rply; // the reply the server sent to us for HELO
 
   /**
    * Initialize the class so that the data is in a known state.
@@ -109,48 +109,48 @@ 
    * @access public
    * @return bool
    */
-  public function Connect($host,$port=0,$tval=30) {
+  public function Connect($host, $port = 0, $tval = 30) {
     // set the error val to null so there is no confusion
     $this->error = null;
 
     // make sure we are __not__ connected
-    if($this->connected()) {
+    if ($this->connected()) {
       // already connected, generate error
       $this->error = array("error" => "Already connected to a server");
       return false;
     }
 
-    if(empty($port)) {
+    if (empty($port)) {
       $port = $this->SMTP_PORT;
     }
 
     // connect to the smtp server
-    $this->smtp_conn = @fsockopen($host,    // the host of the server
-                                 $port,    // the port to use
-                                 $errno,   // error number if any
-                                 $errstr,  // error message if any
-                                 $tval);   // give up after ? secs
+    $this->smtp_conn = @fsockopen($host, // the host of the server
+                                 $port, // the port to use
+                                 $errno, // error number if any
+                                 $errstr, // error message if any
+                                 $tval); // give up after ? secs
     // verify we connected properly
-    if(empty($this->smtp_conn)) {
+    if (empty($this->smtp_conn)) {
       $this->error = array("error" => "Failed to connect to server",
                            "errno" => $errno,
                            "errstr" => $errstr);
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": $errstr ($errno)" . $this->CRLF . '<br />';
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": $errstr ($errno)".$this->CRLF.'<br />';
       }
       return false;
     }
 
     // SMTP server can take longer to respond, give longer timeout for first read
     // Windows does not have support for this timeout function
-    if(substr(PHP_OS, 0, 3) != "WIN")
+    if (substr(PHP_OS, 0, 3) != "WIN")
      socket_set_timeout($this->smtp_conn, $tval, 0);
 
     // get any announcement
     $announce = $this->get_lines();
 
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $announce . $this->CRLF . '<br />';
+    if ($this->do_debug >= 2) {
+      echo "SMTP -> FROM SERVER:".$announce.$this->CRLF.'<br />';
     }
 
     return true;
@@ -168,33 +168,33 @@ 
   public function StartTLS() {
     $this->error = null; # to avoid confusion
 
-    if(!$this->connected()) {
+    if (!$this->connected()) {
       $this->error = array("error" => "Called StartTLS() without being connected");
       return false;
     }
 
-    fputs($this->smtp_conn,"STARTTLS" . $this->CRLF);
+    fputs($this->smtp_conn, "STARTTLS".$this->CRLF);
 
     $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+    $code = substr($rply, 0, 3);
 
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+    if ($this->do_debug >= 2) {
+      echo "SMTP -> FROM SERVER:".$rply.$this->CRLF.'<br />';
     }
 
-    if($code != 220) {
+    if ($code != 220) {
       $this->error =
          array("error"     => "STARTTLS not accepted from server",
                "smtp_code" => $code,
-               "smtp_msg"  => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+               "smtp_msg"  => substr($rply, 4));
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": ".$rply.$this->CRLF.'<br />';
       }
       return false;
     }
 
     //Begin encrypted connection
-    if(!stream_socket_enable_crypto($this->smtp_conn, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
+    if (!stream_socket_enable_crypto($this->smtp_conn, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
       return false;
     }
 
@@ -209,52 +209,52 @@ 
    */
   public function Authenticate($username, $password) {
     // Start authentication
-    fputs($this->smtp_conn,"AUTH LOGIN" . $this->CRLF);
+    fputs($this->smtp_conn, "AUTH LOGIN".$this->CRLF);
 
     $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+    $code = substr($rply, 0, 3);
 
-    if($code != 334) {
+    if ($code != 334) {
       $this->error =
         array("error" => "AUTH not accepted from server",
               "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+              "smtp_msg" => substr($rply, 4));
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": ".$rply.$this->CRLF.'<br />';
       }
       return false;
     }
 
     // Send encoded username
-    fputs($this->smtp_conn, base64_encode($username) . $this->CRLF);
+    fputs($this->smtp_conn, base64_encode($username).$this->CRLF);
 
     $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+    $code = substr($rply, 0, 3);
 
-    if($code != 334) {
+    if ($code != 334) {
       $this->error =
         array("error" => "Username not accepted from server",
               "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+              "smtp_msg" => substr($rply, 4));
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": ".$rply.$this->CRLF.'<br />';
       }
       return false;
     }
 
     // Send encoded password
-    fputs($this->smtp_conn, base64_encode($password) . $this->CRLF);
+    fputs($this->smtp_conn, base64_encode($password).$this->CRLF);
 
     $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+    $code = substr($rply, 0, 3);
 
-    if($code != 235) {
+    if ($code != 235) {
       $this->error =
         array("error" => "Password not accepted from server",
               "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+              "smtp_msg" => substr($rply, 4));
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": ".$rply.$this->CRLF.'<br />';
       }
       return false;
     }
@@ -268,12 +268,12 @@ 
    * @return bool
    */
   public function Connected() {
-    if(!empty($this->smtp_conn)) {
+    if (!empty($this->smtp_conn)) {
       $sock_status = socket_get_status($this->smtp_conn);
-      if($sock_status["eof"]) {
+      if ($sock_status["eof"]) {
         // the socket is valid but we are not connected
-        if($this->do_debug >= 1) {
-            echo "SMTP -> NOTICE:" . $this->CRLF . "EOF caught while checking if connected";
+        if ($this->do_debug >= 1) {
+            echo "SMTP -> NOTICE:".$this->CRLF."EOF caught while checking if connected";
         }
         $this->Close();
         return false;
@@ -293,7 +293,7 @@ 
   public function Close() {
     $this->error = null; // so there is no confusion
     $this->helo_rply = null;
-    if(!empty($this->smtp_conn)) {
+    if (!empty($this->smtp_conn)) {
       // close the connection and cleanup
       fclose($this->smtp_conn);
       $this->smtp_conn = 0;
@@ -326,28 +326,28 @@ 
   public function Data($msg_data) {
     $this->error = null; // so no confusion is caused
 
-    if(!$this->connected()) {
+    if (!$this->connected()) {
       $this->error = array(
               "error" => "Called Data() without being connected");
       return false;
     }
 
-    fputs($this->smtp_conn,"DATA" . $this->CRLF);
+    fputs($this->smtp_conn, "DATA".$this->CRLF);
 
     $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+    $code = substr($rply, 0, 3);
 
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+    if ($this->do_debug >= 2) {
+      echo "SMTP -> FROM SERVER:".$rply.$this->CRLF.'<br />';
     }
 
-    if($code != 354) {
+    if ($code != 354) {
       $this->error =
         array("error" => "DATA command not accepted from server",
               "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+              "smtp_msg" => substr($rply, 4));
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": ".$rply.$this->CRLF.'<br />';
       }
       return false;
     }
@@ -364,9 +364,9 @@ 
      */
 
     // normalize the line breaks so we know the explode works
-    $msg_data = str_replace("\r\n","\n",$msg_data);
-    $msg_data = str_replace("\r","\n",$msg_data);
-    $lines = explode("\n",$msg_data);
+    $msg_data = str_replace("\r\n", "\n", $msg_data);
+    $msg_data = str_replace("\r", "\n", $msg_data);
+    $lines = explode("\n", $msg_data);
 
     /* we need to find a good way to determine is headers are
      * in the msg_data or if it is a straight msg body
@@ -377,72 +377,72 @@ 
      * headers.
      */
 
-    $field = substr($lines[0],0,strpos($lines[0],":"));
+    $field = substr($lines[0], 0, strpos($lines[0], ":"));
     $in_headers = false;
-    if(!empty($field) && !strstr($field," ")) {
+    if (!empty($field) && !strstr($field, " ")) {
       $in_headers = true;
     }
 
     $max_line_length = 998; // used below; set here for ease in change
 
-    while(list(,$line) = @each($lines)) {
+    while (list(,$line) = @each($lines)) {
       $lines_out = null;
-      if($line == "" && $in_headers) {
+      if ($line == "" && $in_headers) {
         $in_headers = false;
       }
       // ok we need to break this line up into several smaller lines
-      while(strlen($line) > $max_line_length) {
-        $pos = strrpos(substr($line,0,$max_line_length)," ");
+      while (strlen($line) > $max_line_length) {
+        $pos = strrpos(substr($line, 0, $max_line_length), " ");
 
         // Patch to fix DOS attack
-        if(!$pos) {
+        if (!$pos) {
           $pos = $max_line_length - 1;
-          $lines_out[] = substr($line,0,$pos);
-          $line = substr($line,$pos);
+          $lines_out[] = substr($line, 0, $pos);
+          $line = substr($line, $pos);
         } else {
-          $lines_out[] = substr($line,0,$pos);
-          $line = substr($line,$pos + 1);
+          $lines_out[] = substr($line, 0, $pos);
+          $line = substr($line, $pos + 1);
         }
 
         /* if we are processing headers we need to
          * add a LWSP-char to the front of the new line
          * rfc 822 on long msg headers
          */
-        if($in_headers) {
-          $line = "\t" . $line;
+        if ($in_headers) {
+          $line = "\t".$line;
         }
       }
       $lines_out[] = $line;
 
       // send the lines to the server
-      while(list(,$line_out) = @each($lines_out)) {
-        if(strlen($line_out) > 0)
+      while (list(,$line_out) = @each($lines_out)) {
+        if (strlen($line_out) > 0)
         {
-          if(substr($line_out, 0, 1) == ".") {
-            $line_out = "." . $line_out;
+          if (substr($line_out, 0, 1) == ".") {
+            $line_out = ".".$line_out;
           }
         }
-        fputs($this->smtp_conn,$line_out . $this->CRLF);
+        fputs($this->smtp_conn, $line_out.$this->CRLF);
       }
     }
 
     // message data has been sent
-    fputs($this->smtp_conn, $this->CRLF . "." . $this->CRLF);
+    fputs($this->smtp_conn, $this->CRLF.".".$this->CRLF);
 
     $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+    $code = substr($rply, 0, 3);
 
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+    if ($this->do_debug >= 2) {
+      echo "SMTP -> FROM SERVER:".$rply.$this->CRLF.'<br />';
     }
 
-    if($code != 250) {
+    if ($code != 250) {
       $this->error =
         array("error" => "DATA not accepted from server",
               "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+              "smtp_msg" => substr($rply, 4));
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": ".$rply.$this->CRLF.'<br />';
       }
       return false;
     }
@@ -464,21 +464,21 @@ 
   public function Hello($host = '') {
     $this->error = null; // so no confusion is caused
 
-    if(!$this->connected()) {
+    if (!$this->connected()) {
       $this->error = array(
             "error" => "Called Hello() without being connected");
       return false;
     }
 
     // if hostname for HELO was not specified send default
-    if(empty($host)) {
+    if (empty($host)) {
       // determine appropriate default to send to server
       $host = "localhost";
     }
 
     // Send extended hello first (RFC 2821)
-    if(!$this->SendHello("EHLO", $host)) {
-      if(!$this->SendHello("HELO", $host)) {
+    if (!$this->SendHello("EHLO", $host)) {
+      if (!$this->SendHello("HELO", $host)) {
           return false;
     }
     }
@@ -492,22 +492,22 @@ 
    * @return bool
    */
   private function SendHello($hello, $host) {
-    fputs($this->smtp_conn, $hello . " " . $host . $this->CRLF);
+    fputs($this->smtp_conn, $hello." ".$host.$this->CRLF);
 
     $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+    $code = substr($rply, 0, 3);
 
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER: " . $rply . $this->CRLF . '<br />';
+    if ($this->do_debug >= 2) {
+      echo "SMTP -> FROM SERVER: ".$rply.$this->CRLF.'<br />';
     }
 
-    if($code != 250) {
+    if ($code != 250) {
       $this->error =
-        array("error" => $hello . " not accepted from server",
+        array("error" => $hello." not accepted from server",
               "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+              "smtp_msg" => substr($rply, 4));
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": ".$rply.$this->CRLF.'<br />';
       }
       return false;
     }
@@ -534,29 +534,29 @@ 
   public function Mail($from) {
     $this->error = null; // so no confusion is caused
 
-    if(!$this->connected()) {
+    if (!$this->connected()) {
       $this->error = array(
               "error" => "Called Mail() without being connected");
       return false;
     }
 
     $useVerp = ($this->do_verp ? "XVERP" : "");
-    fputs($this->smtp_conn,"MAIL FROM:<" . $from . ">" . $useVerp . $this->CRLF);
+    fputs($this->smtp_conn, "MAIL FROM:<".$from.">".$useVerp.$this->CRLF);
 
     $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+    $code = substr($rply, 0, 3);
 
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+    if ($this->do_debug >= 2) {
+      echo "SMTP -> FROM SERVER:".$rply.$this->CRLF.'<br />';
     }
 
-    if($code != 250) {
+    if ($code != 250) {
       $this->error =
         array("error" => "MAIL not accepted from server",
               "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+              "smtp_msg" => substr($rply, 4));
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": ".$rply.$this->CRLF.'<br />';
       }
       return false;
     }
@@ -574,41 +574,41 @@ 
    * @access public
    * @return bool
    */
-  public function Quit($close_on_error=true) {
+  public function Quit($close_on_error = true) {
     $this->error = null; // so there is no confusion
 
-    if(!$this->connected()) {
+    if (!$this->connected()) {
       $this->error = array(
               "error" => "Called Quit() without being connected");
       return false;
     }
 
     // send the quit command to the server
-    fputs($this->smtp_conn,"quit" . $this->CRLF);
+    fputs($this->smtp_conn, "quit".$this->CRLF);
 
     // get any good-bye messages
     $byemsg = $this->get_lines();
 
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $byemsg . $this->CRLF . '<br />';
+    if ($this->do_debug >= 2) {
+      echo "SMTP -> FROM SERVER:".$byemsg.$this->CRLF.'<br />';
     }
 
     $rval = true;
     $e = null;
 
-    $code = substr($byemsg,0,3);
-    if($code != 221) {
+    $code = substr($byemsg, 0, 3);
+    if ($code != 221) {
       // use e as a tmp var cause Close will overwrite $this->error
       $e = array("error" => "SMTP server rejected quit command",
                  "smtp_code" => $code,
-                 "smtp_rply" => substr($byemsg,4));
+                 "smtp_rply" => substr($byemsg, 4));
       $rval = false;
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $e["error"] . ": " . $byemsg . $this->CRLF . '<br />';
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$e["error"].": ".$byemsg.$this->CRLF.'<br />';
       }
     }
 
-    if(empty($e) || $close_on_error) {
+    if (empty($e) || $close_on_error) {
       $this->Close();
     }
 
@@ -630,28 +630,28 @@ 
   public function Recipient($to) {
     $this->error = null; // so no confusion is caused
 
-    if(!$this->connected()) {
+    if (!$this->connected()) {
       $this->error = array(
               "error" => "Called Recipient() without being connected");
       return false;
     }
 
-    fputs($this->smtp_conn,"RCPT TO:<" . $to . ">" . $this->CRLF);
+    fputs($this->smtp_conn, "RCPT TO:<".$to.">".$this->CRLF);
 
     $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+    $code = substr($rply, 0, 3);
 
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+    if ($this->do_debug >= 2) {
+      echo "SMTP -> FROM SERVER:".$rply.$this->CRLF.'<br />';
     }
 
-    if($code != 250 && $code != 251) {
+    if ($code != 250 && $code != 251) {
       $this->error =
         array("error" => "RCPT not accepted from server",
               "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+              "smtp_msg" => substr($rply, 4));
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": ".$rply.$this->CRLF.'<br />';
       }
       return false;
     }
@@ -673,28 +673,28 @@ 
   public function Reset() {
     $this->error = null; // so no confusion is caused
 
-    if(!$this->connected()) {
+    if (!$this->connected()) {
       $this->error = array(
               "error" => "Called Reset() without being connected");
       return false;
     }
 
-    fputs($this->smtp_conn,"RSET" . $this->CRLF);
+    fputs($this->smtp_conn, "RSET".$this->CRLF);
 
     $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+    $code = substr($rply, 0, 3);
 
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+    if ($this->do_debug >= 2) {
+      echo "SMTP -> FROM SERVER:".$rply.$this->CRLF.'<br />';
     }
 
-    if($code != 250) {
+    if ($code != 250) {
       $this->error =
         array("error" => "RSET failed",
               "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+              "smtp_msg" => substr($rply, 4));
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": ".$rply.$this->CRLF.'<br />';
       }
       return false;
     }
@@ -721,28 +721,28 @@ 
   public function SendAndMail($from) {
     $this->error = null; // so no confusion is caused
 
-    if(!$this->connected()) {
+    if (!$this->connected()) {
       $this->error = array(
           "error" => "Called SendAndMail() without being connected");
       return false;
     }
 
-    fputs($this->smtp_conn,"SAML FROM:" . $from . $this->CRLF);
+    fputs($this->smtp_conn, "SAML FROM:".$from.$this->CRLF);
 
     $rply = $this->get_lines();
-    $code = substr($rply,0,3);
+    $code = substr($rply, 0, 3);
 
-    if($this->do_debug >= 2) {
-      echo "SMTP -> FROM SERVER:" . $rply . $this->CRLF . '<br />';
+    if ($this->do_debug >= 2) {
+      echo "SMTP -> FROM SERVER:".$rply.$this->CRLF.'<br />';
     }
 
-    if($code != 250) {
+    if ($code != 250) {
       $this->error =
         array("error" => "SAML not accepted from server",
               "smtp_code" => $code,
-              "smtp_msg" => substr($rply,4));
-      if($this->do_debug >= 1) {
-        echo "SMTP -> ERROR: " . $this->error["error"] . ": " . $rply . $this->CRLF . '<br />';
+              "smtp_msg" => substr($rply, 4));
+      if ($this->do_debug >= 1) {
+        echo "SMTP -> ERROR: ".$this->error["error"].": ".$rply.$this->CRLF.'<br />';
       }
       return false;
     }
@@ -765,8 +765,8 @@ 
   public function Turn() {
     $this->error = array("error" => "This method, TURN, of the SMTP ".
                                     "is not implemented");
-    if($this->do_debug >= 1) {
-      echo "SMTP -> NOTICE: " . $this->error["error"] . $this->CRLF . '<br />';
+    if ($this->do_debug >= 1) {
+      echo "SMTP -> NOTICE: ".$this->error["error"].$this->CRLF.'<br />';
     }
     return false;
   }
@@ -795,17 +795,17 @@ 
    */
   private function get_lines() {
     $data = "";
-    while($str = @fgets($this->smtp_conn,515)) {
-      if($this->do_debug >= 4) {
-        echo "SMTP -> get_lines(): \$data was \"$data\"" . $this->CRLF . '<br />';
-        echo "SMTP -> get_lines(): \$str is \"$str\"" . $this->CRLF . '<br />';
+    while ($str = @fgets($this->smtp_conn, 515)) {
+      if ($this->do_debug >= 4) {
+        echo "SMTP -> get_lines(): \$data was \"$data\"".$this->CRLF.'<br />';
+        echo "SMTP -> get_lines(): \$str is \"$str\"".$this->CRLF.'<br />';
       }
       $data .= $str;
-      if($this->do_debug >= 4) {
-        echo "SMTP -> get_lines(): \$data is \"$data\"" . $this->CRLF . '<br />';
+      if ($this->do_debug >= 4) {
+        echo "SMTP -> get_lines(): \$data is \"$data\"".$this->CRLF.'<br />';
       }
       // if 4th character is a space, we are done reading, break the loop
-      if(substr($str,3,1) == " ") { break; }
+      if (substr($str, 3, 1) == " ") { break; }
     }
     return $data;
   }

libs/tar.class.php

Doc Comments +24 added lines

@@ -84,6 +84,10 @@ 
     // Computes the unsigned Checksum of a file's header
     // to try to ensure valid file
     // PRIVATE ACCESS FUNCTION
+
+    /**
+     * @param string $bytestring
+     */
     function __computeUnsignedChecksum($bytestring) {
         for($i=0; $i<512; $i++)
             $unsigned_chksum += ord($bytestring[$i]);
@@ -97,6 +101,10 @@ 
 
     // Converts a NULL padded string to a non-NULL padded string
     // PRIVATE ACCESS FUNCTION
+
+    /**
+     * @param string $string
+     */
     function __parseNullPaddedString($string) {
         $position = strpos($string,chr(0));
 		if(!$position)
@@ -357,6 +365,10 @@ 
 
 
     // Open a TAR file
+
+    /**
+     * @param string $filename
+     */
     function openTAR($filename) {
         // Clear any values from previous tar archives
         unset($this->filename);
@@ -393,6 +405,10 @@ 
 
 
     // Retrieves information about a file in the current tar archive
+
+    /**
+     * @param string $filename
+     */
     function getFile($filename) {
         if($this->numFiles > 0) {
             foreach($this->files as $key => $information) {
@@ -467,6 +483,10 @@ 
 
 
     // Add a file to the tar archive
+
+    /**
+     * @param string $filename
+     */
     function addFile($filename,$from=null,$to=null) {
         // Make sure the file we are adding exists!
         if(!file_exists($filename))
@@ -555,6 +575,10 @@ 
 
 
     // Saves tar archive to a different file than the current file
+
+    /**
+     * @param boolean $useGzip
+     */
     function toTar($filename,$useGzip) {
         if(!$filename)
             return false;

Indentation +431 added lines, -431 removed lines

@@ -63,99 +63,99 @@ 
 */
 
 class tar {
-    // Unprocessed Archive Information
-    var $filename;
-    var $isGzipped;
-    var $tar_file;
-
-    // Processed Archive Information
-    var $files;
-    var $directories;
-    var $numFiles;
-    var $numDirectories;
-
-
-    // Class Constructor -- Does nothing...
-    function tar() {
-        return true;
-    }
-
-
-    // Computes the unsigned Checksum of a file's header
-    // to try to ensure valid file
-    // PRIVATE ACCESS FUNCTION
-    function __computeUnsignedChecksum($bytestring) {
-        for($i=0; $i<512; $i++)
-            $unsigned_chksum += ord($bytestring[$i]);
-        for($i=0; $i<8; $i++)
-            $unsigned_chksum -= ord($bytestring[148 + $i]);
-        $unsigned_chksum += ord(" ") * 8;
-
-        return $unsigned_chksum;
-    }
-
-
-    // Converts a NULL padded string to a non-NULL padded string
-    // PRIVATE ACCESS FUNCTION
-    function __parseNullPaddedString($string) {
-        $position = strpos($string,chr(0));
+	// Unprocessed Archive Information
+	var $filename;
+	var $isGzipped;
+	var $tar_file;
+
+	// Processed Archive Information
+	var $files;
+	var $directories;
+	var $numFiles;
+	var $numDirectories;
+
+
+	// Class Constructor -- Does nothing...
+	function tar() {
+		return true;
+	}
+
+
+	// Computes the unsigned Checksum of a file's header
+	// to try to ensure valid file
+	// PRIVATE ACCESS FUNCTION
+	function __computeUnsignedChecksum($bytestring) {
+		for($i=0; $i<512; $i++)
+			$unsigned_chksum += ord($bytestring[$i]);
+		for($i=0; $i<8; $i++)
+			$unsigned_chksum -= ord($bytestring[148 + $i]);
+		$unsigned_chksum += ord(" ") * 8;
+
+		return $unsigned_chksum;
+	}
+
+
+	// Converts a NULL padded string to a non-NULL padded string
+	// PRIVATE ACCESS FUNCTION
+	function __parseNullPaddedString($string) {
+		$position = strpos($string,chr(0));
 		if(!$position)
 		{
 			$position = strlen($string);
 		}
-        return substr($string,0,$position);
-    }
+		return substr($string,0,$position);
+	}
 
 
-    // This function parses the current TAR file
-    // PRIVATE ACCESS FUNCTION
-    function __parseTar() {
-        // Read Files from archive
-        $tar_length = strlen($this->tar_file);
-        $main_offset = 0;
+	// This function parses the current TAR file
+	// PRIVATE ACCESS FUNCTION
+	function __parseTar() {
+		// Read Files from archive
+		$tar_length = strlen($this->tar_file);
+		$main_offset = 0;
 		$flag_longlink = false;
-        while($main_offset < $tar_length) {
-            // If we read a block of 512 nulls, we are at the end of the archive
-            if(substr($this->tar_file,$main_offset,512) == str_repeat(chr(0),512))
-                break;
+		while($main_offset < $tar_length) {
+			// If we read a block of 512 nulls, we are at the end of the archive
+			if(substr($this->tar_file,$main_offset,512) == str_repeat(chr(0),512))
+				break;
 
-            // Parse file name
-            $file_name      = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset,100));
+			// Parse file name
+			$file_name      = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset,100));
 
-            // Parse the file mode
-            $file_mode      = substr($this->tar_file,$main_offset + 100,8);
+			// Parse the file mode
+			$file_mode      = substr($this->tar_file,$main_offset + 100,8);
 
-            // Parse the file user ID
-            $file_uid       = octdec(substr($this->tar_file,$main_offset + 108,8));
+			// Parse the file user ID
+			$file_uid       = octdec(substr($this->tar_file,$main_offset + 108,8));
 
-            // Parse the file group ID
-            $file_gid       = octdec(substr($this->tar_file,$main_offset + 116,8));
+			// Parse the file group ID
+			$file_gid       = octdec(substr($this->tar_file,$main_offset + 116,8));
 
-            // Parse the file size
-            $file_size      = octdec(substr($this->tar_file,$main_offset + 124,12));
+			// Parse the file size
+			$file_size      = octdec(substr($this->tar_file,$main_offset + 124,12));
 
-            // Parse the file update time - unix timestamp format
-            $file_time      = octdec(substr($this->tar_file,$main_offset + 136,12));
+			// Parse the file update time - unix timestamp format
+			$file_time      = octdec(substr($this->tar_file,$main_offset + 136,12));
 
-            // Parse Checksum
-            $file_chksum        = octdec(substr($this->tar_file,$main_offset + 148,6));
+			// Parse Checksum
+			$file_chksum        = octdec(substr($this->tar_file,$main_offset + 148,6));
 
-            // Parse user name
-            $file_uname     = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset + 265,32));
+			// Parse user name
+			$file_uname     = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset + 265,32));
 
-            // Parse Group name
-            $file_gname     = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset + 297,32));
+			// Parse Group name
+			$file_gname     = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset + 297,32));
 
-            $file_type = substr($this->tar_file,$main_offset + 156,1);
+			$file_type = substr($this->tar_file,$main_offset + 156,1);
 
-            // Make sure our file is valid
-            if($this->__computeUnsignedChecksum(substr($this->tar_file,$main_offset,512)) != $file_chksum)
-                return false;
+			// Make sure our file is valid
+			if($this->__computeUnsignedChecksum(substr($this->tar_file,$main_offset,512)) != $file_chksum)
+				return false;
 
-            // Parse File Contents
-            $file_contents      = substr($this->tar_file,$main_offset + 512,$file_size);
+			// Parse File Contents
+			$file_contents      = substr($this->tar_file,$main_offset + 512,$file_size);
 
-            /*  ### Unused Header Information ###
+			/*  ### Unused Header Information ###
                 $activeFile["typeflag"]     = substr($this->tar_file,$main_offset + 156,1);
                 $activeFile["linkname"]     = substr($this->tar_file,$main_offset + 157,100);
                 $activeFile["magic"]        = substr($this->tar_file,$main_offset + 257,6);
@@ -228,363 +228,363 @@ 
 				$flag_longlink = false;
 			}
 
-            // Move our offset the number of blocks we have processed
-            $main_offset += 512 + (ceil($file_size / 512) * 512);
-        }
-
-        return true;
-    }
-
-
-    // Read a non gzipped tar file in for processing
-    // PRIVATE ACCESS FUNCTION
-    function __readTar($filename='') {
-        // Set the filename to load
-        if(!$filename)
-            $filename = $this->filename;
-
-        // Read in the TAR file
-        $fp = fopen($filename,"rb");
-        $this->tar_file = fread($fp,filesize($filename));
-        fclose($fp);
-
-        if($this->tar_file[0] == chr(31) && $this->tar_file[1] == chr(139) && $this->tar_file[2] == chr(8)) {
-            if(!function_exists("gzinflate"))
-                return false;
-
-            $this->isGzipped = TRUE;
-
-            $this->tar_file = gzinflate(substr($this->tar_file,10,-4));
-        }
-
-        // Parse the TAR file
-        $this->__parseTar();
-
-        return true;
-    }
-
-
-    // Generates a TAR file from the processed data
-    // PRIVATE ACCESS FUNCTION
-    function __generateTAR() {
-        // Clear any data currently in $this->tar_file
-        unset($this->tar_file);
-
-        // Generate Records for each directory, if we have directories
-        if($this->numDirectories > 0) {
-            foreach($this->directories as $key => $information) {
-                unset($header);
-
-                // Generate tar header for this directory
-                // Filename, Permissions, UID, GID, size, Time, checksum, typeflag, linkname, magic, version, user name, group name, devmajor, devminor, prefix, end
-                $header .= str_pad($information["name"],100,chr(0));
-                $header .= str_pad(decoct($information["mode"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["user_id"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["group_id"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct(0),11,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["time"]),11,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_repeat(" ",8);
-                $header .= "5";
-                $header .= str_repeat(chr(0),100);
-                $header .= str_pad("ustar",6,chr(32));
-                $header .= chr(32) . chr(0);
-                $header .= str_pad("",32,chr(0));
-                $header .= str_pad("",32,chr(0));
-                $header .= str_repeat(chr(0),8);
-                $header .= str_repeat(chr(0),8);
-                $header .= str_repeat(chr(0),155);
-                $header .= str_repeat(chr(0),12);
-
-                // Compute header checksum
-                $checksum = str_pad(decoct($this->__computeUnsignedChecksum($header)),6,"0",STR_PAD_LEFT);
-                for($i=0; $i<6; $i++) {
-                    $header[(148 + $i)] = substr($checksum,$i,1);
-                }
-                $header[154] = chr(0);
-                $header[155] = chr(32);
-
-                // Add new tar formatted data to tar file contents
-                $this->tar_file .= $header;
-            }
-        }
-
-        // Generate Records for each file, if we have files (We should...)
-        if($this->numFiles > 0) {
-            foreach($this->files as $key => $information) {
-                unset($header);
-
-                // Generate the TAR header for this file
-                // Filename, Permissions, UID, GID, size, Time, checksum, typeflag, linkname, magic, version, user name, group name, devmajor, devminor, prefix, end
-                $header .= str_pad($information["name"],100,chr(0));
-                $header .= str_pad(decoct($information["mode"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["user_id"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["group_id"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["size"]),11,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["time"]),11,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_repeat(" ",8);
-                $header .= "0";
-                $header .= str_repeat(chr(0),100);
-                $header .= str_pad("ustar",6,chr(32));
-                $header .= chr(32) . chr(0);
-                $header .= str_pad($information["user_name"],32,chr(0));    // How do I get a file's user name from PHP?
-                $header .= str_pad($information["group_name"],32,chr(0));   // How do I get a file's group name from PHP?
-                $header .= str_repeat(chr(0),8);
-                $header .= str_repeat(chr(0),8);
-                $header .= str_repeat(chr(0),155);
-                $header .= str_repeat(chr(0),12);
-
-                // Compute header checksum
-                $checksum = str_pad(decoct($this->__computeUnsignedChecksum($header)),6,"0",STR_PAD_LEFT);
-                for($i=0; $i<6; $i++) {
-                    $header[(148 + $i)] = substr($checksum,$i,1);
-                }
-                $header[154] = chr(0);
-                $header[155] = chr(32);
-
-                // Pad file contents to byte count divisible by 512
-                $file_contents = str_pad($information["file"],(ceil($information["size"] / 512) * 512),chr(0));
-
-                // Add new tar formatted data to tar file contents
-                $this->tar_file .= $header . $file_contents;
-            }
-        }
-
-        // Add 512 bytes of NULLs to designate EOF
-        $this->tar_file .= str_repeat(chr(0),512);
-
-        return true;
-    }
-
-
-    // Open a TAR file
-    function openTAR($filename) {
-        // Clear any values from previous tar archives
-        unset($this->filename);
-        unset($this->isGzipped);
-        unset($this->tar_file);
-        unset($this->files);
-        unset($this->directories);
-        unset($this->numFiles);
-        unset($this->numDirectories);
-
-        // If the tar file doesn't exist...
-        if(!file_exists($filename))
-            return false;
-
-        $this->filename = $filename;
-
-        // Parse this file
-        $this->__readTar();
-
-        return true;
-    }
-
-
-    // Appends a tar file to the end of the currently opened tar file
-    function appendTar($filename) {
-        // If the tar file doesn't exist...
-        if(!file_exists($filename))
-            return false;
-
-        $this->__readTar($filename);
-
-        return true;
-    }
-
-
-    // Retrieves information about a file in the current tar archive
-    function getFile($filename) {
-        if($this->numFiles > 0) {
-            foreach($this->files as $key => $information) {
-                if($information["name"] == $filename)
-                    return $information;
-            }
-        }
-
-        return false;
-    }
-
-
-    // Retrieves information about a directory in the current tar archive
-    function getDirectory($dirname) {
-        if($this->numDirectories > 0) {
-            foreach($this->directories as $key => $information) {
-                if($information["name"] == $dirname)
-                    return $information;
-            }
-        }
-
-        return false;
-    }
-
-
-    // Check if this tar archive contains a specific file
-    function containsFile($filename) {
-        if($this->numFiles > 0) {
-            foreach($this->files as $key => $information) {
-                if($information["name"] == $filename)
-                    return true;
-            }
-        }
-
-        return false;
-    }
-
-
-    // Check if this tar archive contains a specific directory
-    function containsDirectory($dirname) {
-        if($this->numDirectories > 0) {
-            foreach($this->directories as $key => $information) {
-                if($information["name"] == $dirname)
-                    return true;
-            }
-        }
-
-        return false;
-    }
-
-
-    // Add a directory to this tar archive
-    function addDirectory($dirname) {
-        if(!file_exists($dirname))
-            return false;
-
-        // Get directory information
-        $file_information = stat($dirname);
-
-        // Add directory to processed data
-        $this->numDirectories++;
-        $activeDir      = &$this->directories[];
-        $activeDir["name"]  = $dirname;
-        $activeDir["mode"]  = $file_information["mode"];
-        $activeDir["time"]  = $file_information["time"];
-        $activeDir["user_id"]   = $file_information["uid"];
-        $activeDir["group_id"]  = $file_information["gid"];
-        $activeDir["checksum"]  = $checksum;
-
-        return true;
-    }
-
-
-    // Add a file to the tar archive
-    function addFile($filename,$from=null,$to=null) {
-        // Make sure the file we are adding exists!
-        if(!file_exists($filename))
-            return false;
-
-        if(filesize($filename)==0)
-            return false;
-
-        // Make sure there are no other files in the archive that have this same filename
-        if($this->containsFile($filename))
-            return false;
-
-        // Get file information
-        $file_information = stat($filename);
-
-        // Read in the file's contents
-        $fp = fopen($filename,"rb");
-        $file_contents = fread($fp,filesize($filename));
-        fclose($fp);
-
-        if($from && $to){
-            $file_contents = str_replace($from,$to,$file_contents);
-            $file_information["size"] = strlen($file_contents);
-        }
-
-        // Add file to processed data
-        $this->numFiles++;
-        $activeFile         = &$this->files[];
-        $activeFile["name"]     = $filename;
-        $activeFile["mode"]     = $file_information["mode"];
-        $activeFile["user_id"]      = $file_information["uid"];
-        $activeFile["group_id"]     = $file_information["gid"];
-        $activeFile["size"]     = $file_information["size"];
-        $activeFile["time"]     = $file_information["mtime"];
-        $activeFile["checksum"]     = $checksum;
-        $activeFile["user_name"]    = "";
-        $activeFile["group_name"]   = "";
-        $activeFile["file"]     = $file_contents;
-
-        return true;
-    }
-
-
-    // Remove a file from the tar archive
-    function removeFile($filename) {
-        if($this->numFiles > 0) {
-            foreach($this->files as $key => $information) {
-                if($information["name"] == $filename) {
-                    $this->numFiles--;
-                    unset($this->files[$key]);
-                    return true;
-                }
-            }
-        }
-
-        return false;
-    }
-
-
-    // Remove a directory from the tar archive
-    function removeDirectory($dirname) {
-        if($this->numDirectories > 0) {
-            foreach($this->directories as $key => $information) {
-                if($information["name"] == $dirname) {
-                    $this->numDirectories--;
-                    unset($this->directories[$key]);
-                    return true;
-                }
-            }
-        }
-
-        return false;
-    }
-
-
-    // Write the currently loaded tar archive to disk
-    function saveTar() {
-        if(!$this->filename)
-            return false;
-
-        // Write tar to current file using specified gzip compression
-        $this->toTar($this->filename,$this->isGzipped);
-
-        return true;
-    }
-
-
-    // Saves tar archive to a different file than the current file
-    function toTar($filename,$useGzip) {
-        if(!$filename)
-            return false;
-
-        // Encode processed files into TAR file format
-        $this->__generateTar();
-
-        // GZ Compress the data if we need to
-        if($useGzip) {
-            // Make sure we have gzip support
-            if(!function_exists("gzencode"))
-                return false;
-
-            $file = gzencode($this->tar_file);
-        } else {
-            $file = $this->tar_file;
-        }
-
-        // Write the TAR file
-        $fp = fopen($filename,"wb");
-        fwrite($fp,$file);
-        fclose($fp);
-
-        return true;
-    }
-
-
-    function toTarStream() {
-        $this->__generateTar();
-        return $this->tar_file;
-    }
+			// Move our offset the number of blocks we have processed
+			$main_offset += 512 + (ceil($file_size / 512) * 512);
+		}
+
+		return true;
+	}
+
+
+	// Read a non gzipped tar file in for processing
+	// PRIVATE ACCESS FUNCTION
+	function __readTar($filename='') {
+		// Set the filename to load
+		if(!$filename)
+			$filename = $this->filename;
+
+		// Read in the TAR file
+		$fp = fopen($filename,"rb");
+		$this->tar_file = fread($fp,filesize($filename));
+		fclose($fp);
+
+		if($this->tar_file[0] == chr(31) && $this->tar_file[1] == chr(139) && $this->tar_file[2] == chr(8)) {
+			if(!function_exists("gzinflate"))
+				return false;
+
+			$this->isGzipped = TRUE;
+
+			$this->tar_file = gzinflate(substr($this->tar_file,10,-4));
+		}
+
+		// Parse the TAR file
+		$this->__parseTar();
+
+		return true;
+	}
+
+
+	// Generates a TAR file from the processed data
+	// PRIVATE ACCESS FUNCTION
+	function __generateTAR() {
+		// Clear any data currently in $this->tar_file
+		unset($this->tar_file);
+
+		// Generate Records for each directory, if we have directories
+		if($this->numDirectories > 0) {
+			foreach($this->directories as $key => $information) {
+				unset($header);
+
+				// Generate tar header for this directory
+				// Filename, Permissions, UID, GID, size, Time, checksum, typeflag, linkname, magic, version, user name, group name, devmajor, devminor, prefix, end
+				$header .= str_pad($information["name"],100,chr(0));
+				$header .= str_pad(decoct($information["mode"]),7,"0",STR_PAD_LEFT) . chr(0);
+				$header .= str_pad(decoct($information["user_id"]),7,"0",STR_PAD_LEFT) . chr(0);
+				$header .= str_pad(decoct($information["group_id"]),7,"0",STR_PAD_LEFT) . chr(0);
+				$header .= str_pad(decoct(0),11,"0",STR_PAD_LEFT) . chr(0);
+				$header .= str_pad(decoct($information["time"]),11,"0",STR_PAD_LEFT) . chr(0);
+				$header .= str_repeat(" ",8);
+				$header .= "5";
+				$header .= str_repeat(chr(0),100);
+				$header .= str_pad("ustar",6,chr(32));
+				$header .= chr(32) . chr(0);
+				$header .= str_pad("",32,chr(0));
+				$header .= str_pad("",32,chr(0));
+				$header .= str_repeat(chr(0),8);
+				$header .= str_repeat(chr(0),8);
+				$header .= str_repeat(chr(0),155);
+				$header .= str_repeat(chr(0),12);
+
+				// Compute header checksum
+				$checksum = str_pad(decoct($this->__computeUnsignedChecksum($header)),6,"0",STR_PAD_LEFT);
+				for($i=0; $i<6; $i++) {
+					$header[(148 + $i)] = substr($checksum,$i,1);
+				}
+				$header[154] = chr(0);
+				$header[155] = chr(32);
+
+				// Add new tar formatted data to tar file contents
+				$this->tar_file .= $header;
+			}
+		}
+
+		// Generate Records for each file, if we have files (We should...)
+		if($this->numFiles > 0) {
+			foreach($this->files as $key => $information) {
+				unset($header);
+
+				// Generate the TAR header for this file
+				// Filename, Permissions, UID, GID, size, Time, checksum, typeflag, linkname, magic, version, user name, group name, devmajor, devminor, prefix, end
+				$header .= str_pad($information["name"],100,chr(0));
+				$header .= str_pad(decoct($information["mode"]),7,"0",STR_PAD_LEFT) . chr(0);
+				$header .= str_pad(decoct($information["user_id"]),7,"0",STR_PAD_LEFT) . chr(0);
+				$header .= str_pad(decoct($information["group_id"]),7,"0",STR_PAD_LEFT) . chr(0);
+				$header .= str_pad(decoct($information["size"]),11,"0",STR_PAD_LEFT) . chr(0);
+				$header .= str_pad(decoct($information["time"]),11,"0",STR_PAD_LEFT) . chr(0);
+				$header .= str_repeat(" ",8);
+				$header .= "0";
+				$header .= str_repeat(chr(0),100);
+				$header .= str_pad("ustar",6,chr(32));
+				$header .= chr(32) . chr(0);
+				$header .= str_pad($information["user_name"],32,chr(0));    // How do I get a file's user name from PHP?
+				$header .= str_pad($information["group_name"],32,chr(0));   // How do I get a file's group name from PHP?
+				$header .= str_repeat(chr(0),8);
+				$header .= str_repeat(chr(0),8);
+				$header .= str_repeat(chr(0),155);
+				$header .= str_repeat(chr(0),12);
+
+				// Compute header checksum
+				$checksum = str_pad(decoct($this->__computeUnsignedChecksum($header)),6,"0",STR_PAD_LEFT);
+				for($i=0; $i<6; $i++) {
+					$header[(148 + $i)] = substr($checksum,$i,1);
+				}
+				$header[154] = chr(0);
+				$header[155] = chr(32);
+
+				// Pad file contents to byte count divisible by 512
+				$file_contents = str_pad($information["file"],(ceil($information["size"] / 512) * 512),chr(0));
+
+				// Add new tar formatted data to tar file contents
+				$this->tar_file .= $header . $file_contents;
+			}
+		}
+
+		// Add 512 bytes of NULLs to designate EOF
+		$this->tar_file .= str_repeat(chr(0),512);
+
+		return true;
+	}
+
+
+	// Open a TAR file
+	function openTAR($filename) {
+		// Clear any values from previous tar archives
+		unset($this->filename);
+		unset($this->isGzipped);
+		unset($this->tar_file);
+		unset($this->files);
+		unset($this->directories);
+		unset($this->numFiles);
+		unset($this->numDirectories);
+
+		// If the tar file doesn't exist...
+		if(!file_exists($filename))
+			return false;
+
+		$this->filename = $filename;
+
+		// Parse this file
+		$this->__readTar();
+
+		return true;
+	}
+
+
+	// Appends a tar file to the end of the currently opened tar file
+	function appendTar($filename) {
+		// If the tar file doesn't exist...
+		if(!file_exists($filename))
+			return false;
+
+		$this->__readTar($filename);
+
+		return true;
+	}
+
+
+	// Retrieves information about a file in the current tar archive
+	function getFile($filename) {
+		if($this->numFiles > 0) {
+			foreach($this->files as $key => $information) {
+				if($information["name"] == $filename)
+					return $information;
+			}
+		}
+
+		return false;
+	}
+
+
+	// Retrieves information about a directory in the current tar archive
+	function getDirectory($dirname) {
+		if($this->numDirectories > 0) {
+			foreach($this->directories as $key => $information) {
+				if($information["name"] == $dirname)
+					return $information;
+			}
+		}
+
+		return false;
+	}
+
+
+	// Check if this tar archive contains a specific file
+	function containsFile($filename) {
+		if($this->numFiles > 0) {
+			foreach($this->files as $key => $information) {
+				if($information["name"] == $filename)
+					return true;
+			}
+		}
+
+		return false;
+	}
+
+
+	// Check if this tar archive contains a specific directory
+	function containsDirectory($dirname) {
+		if($this->numDirectories > 0) {
+			foreach($this->directories as $key => $information) {
+				if($information["name"] == $dirname)
+					return true;
+			}
+		}
+
+		return false;
+	}
+
+
+	// Add a directory to this tar archive
+	function addDirectory($dirname) {
+		if(!file_exists($dirname))
+			return false;
+
+		// Get directory information
+		$file_information = stat($dirname);
+
+		// Add directory to processed data
+		$this->numDirectories++;
+		$activeDir      = &$this->directories[];
+		$activeDir["name"]  = $dirname;
+		$activeDir["mode"]  = $file_information["mode"];
+		$activeDir["time"]  = $file_information["time"];
+		$activeDir["user_id"]   = $file_information["uid"];
+		$activeDir["group_id"]  = $file_information["gid"];
+		$activeDir["checksum"]  = $checksum;
+
+		return true;
+	}
+
+
+	// Add a file to the tar archive
+	function addFile($filename,$from=null,$to=null) {
+		// Make sure the file we are adding exists!
+		if(!file_exists($filename))
+			return false;
+
+		if(filesize($filename)==0)
+			return false;
+
+		// Make sure there are no other files in the archive that have this same filename
+		if($this->containsFile($filename))
+			return false;
+
+		// Get file information
+		$file_information = stat($filename);
+
+		// Read in the file's contents
+		$fp = fopen($filename,"rb");
+		$file_contents = fread($fp,filesize($filename));
+		fclose($fp);
+
+		if($from && $to){
+			$file_contents = str_replace($from,$to,$file_contents);
+			$file_information["size"] = strlen($file_contents);
+		}
+
+		// Add file to processed data
+		$this->numFiles++;
+		$activeFile         = &$this->files[];
+		$activeFile["name"]     = $filename;
+		$activeFile["mode"]     = $file_information["mode"];
+		$activeFile["user_id"]      = $file_information["uid"];
+		$activeFile["group_id"]     = $file_information["gid"];
+		$activeFile["size"]     = $file_information["size"];
+		$activeFile["time"]     = $file_information["mtime"];
+		$activeFile["checksum"]     = $checksum;
+		$activeFile["user_name"]    = "";
+		$activeFile["group_name"]   = "";
+		$activeFile["file"]     = $file_contents;
+
+		return true;
+	}
+
+
+	// Remove a file from the tar archive
+	function removeFile($filename) {
+		if($this->numFiles > 0) {
+			foreach($this->files as $key => $information) {
+				if($information["name"] == $filename) {
+					$this->numFiles--;
+					unset($this->files[$key]);
+					return true;
+				}
+			}
+		}
+
+		return false;
+	}
+
+
+	// Remove a directory from the tar archive
+	function removeDirectory($dirname) {
+		if($this->numDirectories > 0) {
+			foreach($this->directories as $key => $information) {
+				if($information["name"] == $dirname) {
+					$this->numDirectories--;
+					unset($this->directories[$key]);
+					return true;
+				}
+			}
+		}
+
+		return false;
+	}
+
+
+	// Write the currently loaded tar archive to disk
+	function saveTar() {
+		if(!$this->filename)
+			return false;
+
+		// Write tar to current file using specified gzip compression
+		$this->toTar($this->filename,$this->isGzipped);
+
+		return true;
+	}
+
+
+	// Saves tar archive to a different file than the current file
+	function toTar($filename,$useGzip) {
+		if(!$filename)
+			return false;
+
+		// Encode processed files into TAR file format
+		$this->__generateTar();
+
+		// GZ Compress the data if we need to
+		if($useGzip) {
+			// Make sure we have gzip support
+			if(!function_exists("gzencode"))
+				return false;
+
+			$file = gzencode($this->tar_file);
+		} else {
+			$file = $this->tar_file;
+		}
+
+		// Write the TAR file
+		$fp = fopen($filename,"wb");
+		fwrite($fp,$file);
+		fclose($fp);
+
+		return true;
+	}
+
+
+	function toTarStream() {
+		$this->__generateTar();
+		return $this->tar_file;
+	}
 }
 ?>

Braces +60 added lines, -44 removed lines

@@ -85,10 +85,12 @@ 
     // to try to ensure valid file
     // PRIVATE ACCESS FUNCTION
     function __computeUnsignedChecksum($bytestring) {
-        for($i=0; $i<512; $i++)
-            $unsigned_chksum += ord($bytestring[$i]);
-        for($i=0; $i<8; $i++)
-            $unsigned_chksum -= ord($bytestring[148 + $i]);
+        for($i=0; $i<512; $i++) {
+                    $unsigned_chksum += ord($bytestring[$i]);
+        }
+        for($i=0; $i<8; $i++) {
+                    $unsigned_chksum -= ord($bytestring[148 + $i]);
+        }
         $unsigned_chksum += ord(" ") * 8;
 
         return $unsigned_chksum;
@@ -116,8 +118,9 @@ 
 		$flag_longlink = false;
         while($main_offset < $tar_length) {
             // If we read a block of 512 nulls, we are at the end of the archive
-            if(substr($this->tar_file,$main_offset,512) == str_repeat(chr(0),512))
-                break;
+            if(substr($this->tar_file,$main_offset,512) == str_repeat(chr(0),512)) {
+                            break;
+            }
 
             // Parse file name
             $file_name      = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset,100));
@@ -149,8 +152,9 @@ 
             $file_type = substr($this->tar_file,$main_offset + 156,1);
 
             // Make sure our file is valid
-            if($this->__computeUnsignedChecksum(substr($this->tar_file,$main_offset,512)) != $file_chksum)
-                return false;
+            if($this->__computeUnsignedChecksum(substr($this->tar_file,$main_offset,512)) != $file_chksum) {
+                            return false;
+            }
 
             // Parse File Contents
             $file_contents      = substr($this->tar_file,$main_offset + 512,$file_size);
@@ -170,8 +174,7 @@ 
 			{
 				$flag_longlink = true;
 				$longlink_name = $this->__parseNullPaddedString($file_contents);
-			}
-			elseif($file_type == '0') {
+			} elseif($file_type == '0') {
 				// Increment number of files
 				$this->numFiles++;
 
@@ -182,8 +185,7 @@ 
 				if($flag_longlink)
 				{
 					$activeFile["name"]     = $longlink_name;
-				}
-				else
+				} else
 				{
 					$activeFile["name"]     = $file_name;
 				}
@@ -211,8 +213,7 @@ 
 				if($flag_longlink)
 				{
 					$activeDir["name"]     = $longlink_name;
-				}
-				else
+				} else
 				{
 					$activeDir["name"]     = $file_name;
 				}
@@ -240,8 +241,9 @@ 
     // PRIVATE ACCESS FUNCTION
     function __readTar($filename='') {
         // Set the filename to load
-        if(!$filename)
-            $filename = $this->filename;
+        if(!$filename) {
+                    $filename = $this->filename;
+        }
 
         // Read in the TAR file
         $fp = fopen($filename,"rb");
@@ -249,8 +251,9 @@ 
         fclose($fp);
 
         if($this->tar_file[0] == chr(31) && $this->tar_file[1] == chr(139) && $this->tar_file[2] == chr(8)) {
-            if(!function_exists("gzinflate"))
-                return false;
+            if(!function_exists("gzinflate")) {
+                            return false;
+            }
 
             $this->isGzipped = TRUE;
 
@@ -368,8 +371,9 @@ 
         unset($this->numDirectories);
 
         // If the tar file doesn't exist...
-        if(!file_exists($filename))
-            return false;
+        if(!file_exists($filename)) {
+                    return false;
+        }
 
         $this->filename = $filename;
 
@@ -383,8 +387,9 @@ 
     // Appends a tar file to the end of the currently opened tar file
     function appendTar($filename) {
         // If the tar file doesn't exist...
-        if(!file_exists($filename))
-            return false;
+        if(!file_exists($filename)) {
+                    return false;
+        }
 
         $this->__readTar($filename);
 
@@ -396,8 +401,9 @@ 
     function getFile($filename) {
         if($this->numFiles > 0) {
             foreach($this->files as $key => $information) {
-                if($information["name"] == $filename)
-                    return $information;
+                if($information["name"] == $filename) {
+                                    return $information;
+                }
             }
         }
 
@@ -409,8 +415,9 @@ 
     function getDirectory($dirname) {
         if($this->numDirectories > 0) {
             foreach($this->directories as $key => $information) {
-                if($information["name"] == $dirname)
-                    return $information;
+                if($information["name"] == $dirname) {
+                                    return $information;
+                }
             }
         }
 
@@ -422,8 +429,9 @@ 
     function containsFile($filename) {
         if($this->numFiles > 0) {
             foreach($this->files as $key => $information) {
-                if($information["name"] == $filename)
-                    return true;
+                if($information["name"] == $filename) {
+                                    return true;
+                }
             }
         }
 
@@ -435,8 +443,9 @@ 
     function containsDirectory($dirname) {
         if($this->numDirectories > 0) {
             foreach($this->directories as $key => $information) {
-                if($information["name"] == $dirname)
-                    return true;
+                if($information["name"] == $dirname) {
+                                    return true;
+                }
             }
         }
 
@@ -446,8 +455,9 @@ 
 
     // Add a directory to this tar archive
     function addDirectory($dirname) {
-        if(!file_exists($dirname))
-            return false;
+        if(!file_exists($dirname)) {
+                    return false;
+        }
 
         // Get directory information
         $file_information = stat($dirname);
@@ -469,15 +479,18 @@ 
     // Add a file to the tar archive
     function addFile($filename,$from=null,$to=null) {
         // Make sure the file we are adding exists!
-        if(!file_exists($filename))
-            return false;
+        if(!file_exists($filename)) {
+                    return false;
+        }
 
-        if(filesize($filename)==0)
-            return false;
+        if(filesize($filename)==0) {
+                    return false;
+        }
 
         // Make sure there are no other files in the archive that have this same filename
-        if($this->containsFile($filename))
-            return false;
+        if($this->containsFile($filename)) {
+                    return false;
+        }
 
         // Get file information
         $file_information = stat($filename);
@@ -544,8 +557,9 @@ 
 
     // Write the currently loaded tar archive to disk
     function saveTar() {
-        if(!$this->filename)
-            return false;
+        if(!$this->filename) {
+                    return false;
+        }
 
         // Write tar to current file using specified gzip compression
         $this->toTar($this->filename,$this->isGzipped);
@@ -556,8 +570,9 @@ 
 
     // Saves tar archive to a different file than the current file
     function toTar($filename,$useGzip) {
-        if(!$filename)
-            return false;
+        if(!$filename) {
+                    return false;
+        }
 
         // Encode processed files into TAR file format
         $this->__generateTar();
@@ -565,8 +580,9 @@ 
         // GZ Compress the data if we need to
         if($useGzip) {
             // Make sure we have gzip support
-            if(!function_exists("gzencode"))
-                return false;
+            if(!function_exists("gzencode")) {
+                            return false;
+            }
 
             $file = gzencode($this->tar_file);
         } else {

Spacing +120 added lines, -120 removed lines

@@ -85,9 +85,9 @@ 
     // to try to ensure valid file
     // PRIVATE ACCESS FUNCTION
     function __computeUnsignedChecksum($bytestring) {
-        for($i=0; $i<512; $i++)
+        for ($i = 0; $i < 512; $i++)
             $unsigned_chksum += ord($bytestring[$i]);
-        for($i=0; $i<8; $i++)
+        for ($i = 0; $i < 8; $i++)
             $unsigned_chksum -= ord($bytestring[148 + $i]);
         $unsigned_chksum += ord(" ") * 8;
 
@@ -98,12 +98,12 @@ 
     // Converts a NULL padded string to a non-NULL padded string
     // PRIVATE ACCESS FUNCTION
     function __parseNullPaddedString($string) {
-        $position = strpos($string,chr(0));
-		if(!$position)
+        $position = strpos($string, chr(0));
+		if (!$position)
 		{
 			$position = strlen($string);
 		}
-        return substr($string,0,$position);
+        return substr($string, 0, $position);
     }
 
 
@@ -114,46 +114,46 @@ 
         $tar_length = strlen($this->tar_file);
         $main_offset = 0;
 		$flag_longlink = false;
-        while($main_offset < $tar_length) {
+        while ($main_offset < $tar_length) {
             // If we read a block of 512 nulls, we are at the end of the archive
-            if(substr($this->tar_file,$main_offset,512) == str_repeat(chr(0),512))
+            if (substr($this->tar_file, $main_offset, 512) == str_repeat(chr(0), 512))
                 break;
 
             // Parse file name
-            $file_name      = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset,100));
+            $file_name      = $this->__parseNullPaddedString(substr($this->tar_file, $main_offset, 100));
 
             // Parse the file mode
-            $file_mode      = substr($this->tar_file,$main_offset + 100,8);
+            $file_mode      = substr($this->tar_file, $main_offset + 100, 8);
 
             // Parse the file user ID
-            $file_uid       = octdec(substr($this->tar_file,$main_offset + 108,8));
+            $file_uid       = octdec(substr($this->tar_file, $main_offset + 108, 8));
 
             // Parse the file group ID
-            $file_gid       = octdec(substr($this->tar_file,$main_offset + 116,8));
+            $file_gid       = octdec(substr($this->tar_file, $main_offset + 116, 8));
 
             // Parse the file size
-            $file_size      = octdec(substr($this->tar_file,$main_offset + 124,12));
+            $file_size      = octdec(substr($this->tar_file, $main_offset + 124, 12));
 
             // Parse the file update time - unix timestamp format
-            $file_time      = octdec(substr($this->tar_file,$main_offset + 136,12));
+            $file_time      = octdec(substr($this->tar_file, $main_offset + 136, 12));
 
             // Parse Checksum
-            $file_chksum        = octdec(substr($this->tar_file,$main_offset + 148,6));
+            $file_chksum = octdec(substr($this->tar_file, $main_offset + 148, 6));
 
             // Parse user name
-            $file_uname     = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset + 265,32));
+            $file_uname     = $this->__parseNullPaddedString(substr($this->tar_file, $main_offset + 265, 32));
 
             // Parse Group name
-            $file_gname     = $this->__parseNullPaddedString(substr($this->tar_file,$main_offset + 297,32));
+            $file_gname     = $this->__parseNullPaddedString(substr($this->tar_file, $main_offset + 297, 32));
 
-            $file_type = substr($this->tar_file,$main_offset + 156,1);
+            $file_type = substr($this->tar_file, $main_offset + 156, 1);
 
             // Make sure our file is valid
-            if($this->__computeUnsignedChecksum(substr($this->tar_file,$main_offset,512)) != $file_chksum)
+            if ($this->__computeUnsignedChecksum(substr($this->tar_file, $main_offset, 512)) != $file_chksum)
                 return false;
 
             // Parse File Contents
-            $file_contents      = substr($this->tar_file,$main_offset + 512,$file_size);
+            $file_contents = substr($this->tar_file, $main_offset + 512, $file_size);
 
             /*  ### Unused Header Information ###
                 $activeFile["typeflag"]     = substr($this->tar_file,$main_offset + 156,1);
@@ -166,12 +166,12 @@ 
                 $activeFile["endheader"]    = substr($this->tar_file,$main_offset + 500,12);
             */
 
-			if(strtolower($file_type) == 'l' || $file_name == '././@LongLink')
+			if (strtolower($file_type) == 'l' || $file_name == '././@LongLink')
 			{
 				$flag_longlink = true;
 				$longlink_name = $this->__parseNullPaddedString($file_contents);
 			}
-			elseif($file_type == '0') {
+			elseif ($file_type == '0') {
 				// Increment number of files
 				$this->numFiles++;
 
@@ -179,13 +179,13 @@ 
 				$activeFile = &$this->files[];
 
 				// Asign Values
-				if($flag_longlink)
+				if ($flag_longlink)
 				{
-					$activeFile["name"]     = $longlink_name;
+					$activeFile["name"] = $longlink_name;
 				}
 				else
 				{
-					$activeFile["name"]     = $file_name;
+					$activeFile["name"] = $file_name;
 				}
 				$activeFile["type"]     = $file_type;
 				$activeFile["mode"]     = $file_mode;
@@ -196,11 +196,11 @@ 
 				$activeFile["user_name"]    = $file_uname;
 				$activeFile["group_name"]   = $file_gname;
 				$activeFile["checksum"]     = $file_chksum;
-				$activeFile["file"]     = $file_contents;
+				$activeFile["file"] = $file_contents;
 
 				$flag_longlink = false;
 
-			} elseif($file_type == '5') {
+			} elseif ($file_type == '5') {
 				// Increment number of directories
 				$this->numDirectories++;
 
@@ -208,9 +208,9 @@ 
 				$activeDir = &$this->directories[];
 
 				// Assign values
-				if($flag_longlink)
+				if ($flag_longlink)
 				{
-					$activeDir["name"]     = $longlink_name;
+					$activeDir["name"] = $longlink_name;
 				}
 				else
 				{
@@ -238,23 +238,23 @@ 
 
     // Read a non gzipped tar file in for processing
     // PRIVATE ACCESS FUNCTION
-    function __readTar($filename='') {
+    function __readTar($filename = '') {
         // Set the filename to load
-        if(!$filename)
+        if (!$filename)
             $filename = $this->filename;
 
         // Read in the TAR file
-        $fp = fopen($filename,"rb");
-        $this->tar_file = fread($fp,filesize($filename));
+        $fp = fopen($filename, "rb");
+        $this->tar_file = fread($fp, filesize($filename));
         fclose($fp);
 
-        if($this->tar_file[0] == chr(31) && $this->tar_file[1] == chr(139) && $this->tar_file[2] == chr(8)) {
-            if(!function_exists("gzinflate"))
+        if ($this->tar_file[0] == chr(31) && $this->tar_file[1] == chr(139) && $this->tar_file[2] == chr(8)) {
+            if (!function_exists("gzinflate"))
                 return false;
 
             $this->isGzipped = TRUE;
 
-            $this->tar_file = gzinflate(substr($this->tar_file,10,-4));
+            $this->tar_file = gzinflate(substr($this->tar_file, 10, -4));
         }
 
         // Parse the TAR file
@@ -271,34 +271,34 @@ 
         unset($this->tar_file);
 
         // Generate Records for each directory, if we have directories
-        if($this->numDirectories > 0) {
-            foreach($this->directories as $key => $information) {
+        if ($this->numDirectories > 0) {
+            foreach ($this->directories as $key => $information) {
                 unset($header);
 
                 // Generate tar header for this directory
                 // Filename, Permissions, UID, GID, size, Time, checksum, typeflag, linkname, magic, version, user name, group name, devmajor, devminor, prefix, end
-                $header .= str_pad($information["name"],100,chr(0));
-                $header .= str_pad(decoct($information["mode"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["user_id"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["group_id"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct(0),11,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["time"]),11,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_repeat(" ",8);
+                $header .= str_pad($information["name"], 100, chr(0));
+                $header .= str_pad(decoct($information["mode"]), 7, "0", STR_PAD_LEFT).chr(0);
+                $header .= str_pad(decoct($information["user_id"]), 7, "0", STR_PAD_LEFT).chr(0);
+                $header .= str_pad(decoct($information["group_id"]), 7, "0", STR_PAD_LEFT).chr(0);
+                $header .= str_pad(decoct(0), 11, "0", STR_PAD_LEFT).chr(0);
+                $header .= str_pad(decoct($information["time"]), 11, "0", STR_PAD_LEFT).chr(0);
+                $header .= str_repeat(" ", 8);
                 $header .= "5";
-                $header .= str_repeat(chr(0),100);
-                $header .= str_pad("ustar",6,chr(32));
-                $header .= chr(32) . chr(0);
-                $header .= str_pad("",32,chr(0));
-                $header .= str_pad("",32,chr(0));
-                $header .= str_repeat(chr(0),8);
-                $header .= str_repeat(chr(0),8);
-                $header .= str_repeat(chr(0),155);
-                $header .= str_repeat(chr(0),12);
+                $header .= str_repeat(chr(0), 100);
+                $header .= str_pad("ustar", 6, chr(32));
+                $header .= chr(32).chr(0);
+                $header .= str_pad("", 32, chr(0));
+                $header .= str_pad("", 32, chr(0));
+                $header .= str_repeat(chr(0), 8);
+                $header .= str_repeat(chr(0), 8);
+                $header .= str_repeat(chr(0), 155);
+                $header .= str_repeat(chr(0), 12);
 
                 // Compute header checksum
-                $checksum = str_pad(decoct($this->__computeUnsignedChecksum($header)),6,"0",STR_PAD_LEFT);
-                for($i=0; $i<6; $i++) {
-                    $header[(148 + $i)] = substr($checksum,$i,1);
+                $checksum = str_pad(decoct($this->__computeUnsignedChecksum($header)), 6, "0", STR_PAD_LEFT);
+                for ($i = 0; $i < 6; $i++) {
+                    $header[(148 + $i)] = substr($checksum, $i, 1);
                 }
                 $header[154] = chr(0);
                 $header[155] = chr(32);
@@ -309,48 +309,48 @@ 
         }
 
         // Generate Records for each file, if we have files (We should...)
-        if($this->numFiles > 0) {
-            foreach($this->files as $key => $information) {
+        if ($this->numFiles > 0) {
+            foreach ($this->files as $key => $information) {
                 unset($header);
 
                 // Generate the TAR header for this file
                 // Filename, Permissions, UID, GID, size, Time, checksum, typeflag, linkname, magic, version, user name, group name, devmajor, devminor, prefix, end
-                $header .= str_pad($information["name"],100,chr(0));
-                $header .= str_pad(decoct($information["mode"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["user_id"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["group_id"]),7,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["size"]),11,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_pad(decoct($information["time"]),11,"0",STR_PAD_LEFT) . chr(0);
-                $header .= str_repeat(" ",8);
+                $header .= str_pad($information["name"], 100, chr(0));
+                $header .= str_pad(decoct($information["mode"]), 7, "0", STR_PAD_LEFT).chr(0);
+                $header .= str_pad(decoct($information["user_id"]), 7, "0", STR_PAD_LEFT).chr(0);
+                $header .= str_pad(decoct($information["group_id"]), 7, "0", STR_PAD_LEFT).chr(0);
+                $header .= str_pad(decoct($information["size"]), 11, "0", STR_PAD_LEFT).chr(0);
+                $header .= str_pad(decoct($information["time"]), 11, "0", STR_PAD_LEFT).chr(0);
+                $header .= str_repeat(" ", 8);
                 $header .= "0";
-                $header .= str_repeat(chr(0),100);
-                $header .= str_pad("ustar",6,chr(32));
-                $header .= chr(32) . chr(0);
-                $header .= str_pad($information["user_name"],32,chr(0));    // How do I get a file's user name from PHP?
-                $header .= str_pad($information["group_name"],32,chr(0));   // How do I get a file's group name from PHP?
-                $header .= str_repeat(chr(0),8);
-                $header .= str_repeat(chr(0),8);
-                $header .= str_repeat(chr(0),155);
-                $header .= str_repeat(chr(0),12);
+                $header .= str_repeat(chr(0), 100);
+                $header .= str_pad("ustar", 6, chr(32));
+                $header .= chr(32).chr(0);
+                $header .= str_pad($information["user_name"], 32, chr(0)); // How do I get a file's user name from PHP?
+                $header .= str_pad($information["group_name"], 32, chr(0)); // How do I get a file's group name from PHP?
+                $header .= str_repeat(chr(0), 8);
+                $header .= str_repeat(chr(0), 8);
+                $header .= str_repeat(chr(0), 155);
+                $header .= str_repeat(chr(0), 12);
 
                 // Compute header checksum
-                $checksum = str_pad(decoct($this->__computeUnsignedChecksum($header)),6,"0",STR_PAD_LEFT);
-                for($i=0; $i<6; $i++) {
-                    $header[(148 + $i)] = substr($checksum,$i,1);
+                $checksum = str_pad(decoct($this->__computeUnsignedChecksum($header)), 6, "0", STR_PAD_LEFT);
+                for ($i = 0; $i < 6; $i++) {
+                    $header[(148 + $i)] = substr($checksum, $i, 1);
                 }
                 $header[154] = chr(0);
                 $header[155] = chr(32);
 
                 // Pad file contents to byte count divisible by 512
-                $file_contents = str_pad($information["file"],(ceil($information["size"] / 512) * 512),chr(0));
+                $file_contents = str_pad($information["file"], (ceil($information["size"] / 512) * 512), chr(0));
 
                 // Add new tar formatted data to tar file contents
-                $this->tar_file .= $header . $file_contents;
+                $this->tar_file .= $header.$file_contents;
             }
         }
 
         // Add 512 bytes of NULLs to designate EOF
-        $this->tar_file .= str_repeat(chr(0),512);
+        $this->tar_file .= str_repeat(chr(0), 512);
 
         return true;
     }
@@ -368,7 +368,7 @@ 
         unset($this->numDirectories);
 
         // If the tar file doesn't exist...
-        if(!file_exists($filename))
+        if (!file_exists($filename))
             return false;
 
         $this->filename = $filename;
@@ -383,7 +383,7 @@ 
     // Appends a tar file to the end of the currently opened tar file
     function appendTar($filename) {
         // If the tar file doesn't exist...
-        if(!file_exists($filename))
+        if (!file_exists($filename))
             return false;
 
         $this->__readTar($filename);
@@ -394,9 +394,9 @@ 
 
     // Retrieves information about a file in the current tar archive
     function getFile($filename) {
-        if($this->numFiles > 0) {
-            foreach($this->files as $key => $information) {
-                if($information["name"] == $filename)
+        if ($this->numFiles > 0) {
+            foreach ($this->files as $key => $information) {
+                if ($information["name"] == $filename)
                     return $information;
             }
         }
@@ -407,9 +407,9 @@ 
 
     // Retrieves information about a directory in the current tar archive
     function getDirectory($dirname) {
-        if($this->numDirectories > 0) {
-            foreach($this->directories as $key => $information) {
-                if($information["name"] == $dirname)
+        if ($this->numDirectories > 0) {
+            foreach ($this->directories as $key => $information) {
+                if ($information["name"] == $dirname)
                     return $information;
             }
         }
@@ -420,9 +420,9 @@ 
 
     // Check if this tar archive contains a specific file
     function containsFile($filename) {
-        if($this->numFiles > 0) {
-            foreach($this->files as $key => $information) {
-                if($information["name"] == $filename)
+        if ($this->numFiles > 0) {
+            foreach ($this->files as $key => $information) {
+                if ($information["name"] == $filename)
                     return true;
             }
         }
@@ -433,9 +433,9 @@ 
 
     // Check if this tar archive contains a specific directory
     function containsDirectory($dirname) {
-        if($this->numDirectories > 0) {
-            foreach($this->directories as $key => $information) {
-                if($information["name"] == $dirname)
+        if ($this->numDirectories > 0) {
+            foreach ($this->directories as $key => $information) {
+                if ($information["name"] == $dirname)
                     return true;
             }
         }
@@ -446,7 +446,7 @@ 
 
     // Add a directory to this tar archive
     function addDirectory($dirname) {
-        if(!file_exists($dirname))
+        if (!file_exists($dirname))
             return false;
 
         // Get directory information
@@ -454,7 +454,7 @@ 
 
         // Add directory to processed data
         $this->numDirectories++;
-        $activeDir      = &$this->directories[];
+        $activeDir = &$this->directories[];
         $activeDir["name"]  = $dirname;
         $activeDir["mode"]  = $file_information["mode"];
         $activeDir["time"]  = $file_information["time"];
@@ -467,34 +467,34 @@ 
 
 
     // Add a file to the tar archive
-    function addFile($filename,$from=null,$to=null) {
+    function addFile($filename, $from = null, $to = null) {
         // Make sure the file we are adding exists!
-        if(!file_exists($filename))
+        if (!file_exists($filename))
             return false;
 
-        if(filesize($filename)==0)
+        if (filesize($filename) == 0)
             return false;
 
         // Make sure there are no other files in the archive that have this same filename
-        if($this->containsFile($filename))
+        if ($this->containsFile($filename))
             return false;
 
         // Get file information
         $file_information = stat($filename);
 
         // Read in the file's contents
-        $fp = fopen($filename,"rb");
-        $file_contents = fread($fp,filesize($filename));
+        $fp = fopen($filename, "rb");
+        $file_contents = fread($fp, filesize($filename));
         fclose($fp);
 
-        if($from && $to){
-            $file_contents = str_replace($from,$to,$file_contents);
+        if ($from && $to) {
+            $file_contents = str_replace($from, $to, $file_contents);
             $file_information["size"] = strlen($file_contents);
         }
 
         // Add file to processed data
         $this->numFiles++;
-        $activeFile         = &$this->files[];
+        $activeFile = &$this->files[];
         $activeFile["name"]     = $filename;
         $activeFile["mode"]     = $file_information["mode"];
         $activeFile["user_id"]      = $file_information["uid"];
@@ -504,7 +504,7 @@ 
         $activeFile["checksum"]     = $checksum;
         $activeFile["user_name"]    = "";
         $activeFile["group_name"]   = "";
-        $activeFile["file"]     = $file_contents;
+        $activeFile["file"] = $file_contents;
 
         return true;
     }
@@ -512,9 +512,9 @@ 
 
     // Remove a file from the tar archive
     function removeFile($filename) {
-        if($this->numFiles > 0) {
-            foreach($this->files as $key => $information) {
-                if($information["name"] == $filename) {
+        if ($this->numFiles > 0) {
+            foreach ($this->files as $key => $information) {
+                if ($information["name"] == $filename) {
                     $this->numFiles--;
                     unset($this->files[$key]);
                     return true;
@@ -528,9 +528,9 @@ 
 
     // Remove a directory from the tar archive
     function removeDirectory($dirname) {
-        if($this->numDirectories > 0) {
-            foreach($this->directories as $key => $information) {
-                if($information["name"] == $dirname) {
+        if ($this->numDirectories > 0) {
+            foreach ($this->directories as $key => $information) {
+                if ($information["name"] == $dirname) {
                     $this->numDirectories--;
                     unset($this->directories[$key]);
                     return true;
@@ -544,28 +544,28 @@ 
 
     // Write the currently loaded tar archive to disk
     function saveTar() {
-        if(!$this->filename)
+        if (!$this->filename)
             return false;
 
         // Write tar to current file using specified gzip compression
-        $this->toTar($this->filename,$this->isGzipped);
+        $this->toTar($this->filename, $this->isGzipped);
 
         return true;
     }
 
 
     // Saves tar archive to a different file than the current file
-    function toTar($filename,$useGzip) {
-        if(!$filename)
+    function toTar($filename, $useGzip) {
+        if (!$filename)
             return false;
 
         // Encode processed files into TAR file format
         $this->__generateTar();
 
         // GZ Compress the data if we need to
-        if($useGzip) {
+        if ($useGzip) {
             // Make sure we have gzip support
-            if(!function_exists("gzencode"))
+            if (!function_exists("gzencode"))
                 return false;
 
             $file = gzencode($this->tar_file);
@@ -574,8 +574,8 @@ 
         }
 
         // Write the TAR file
-        $fp = fopen($filename,"wb");
-        fwrite($fp,$file);
+        $fp = fopen($filename, "wb");
+        fwrite($fp, $file);
         fclose($fp);
 
         return true;

modules/addon/addon.admin.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -141,7 +141,7 @@
 	 * @param string $addon Name to get information
 	 * @param int $site_srl Site srl
 	 * @param string $gtype site or global
-	 * @return object Returns a information
+	 * @return null|stdClass Returns a information
 	 */
 	function getAddonInfoXml($addon, $site_srl = 0, $gtype = 'site')
 	{

Spacing +53 added lines, -53 removed lines

@@ -27,7 +27,7 @@ 
 	function getAddonPath($addon_name)
 	{
 		$class_path = sprintf('./addons/%s/', $addon_name);
-		if(is_dir($class_path))
+		if (is_dir($class_path))
 		{
 			return $class_path;
 		}
@@ -44,7 +44,7 @@ 
 		$addonList = $this->getAddonList(0, 'site');
 
 		$oAutoinstallModel = getModel('autoinstall');
-		foreach($addonList as $key => $addon)
+		foreach ($addonList as $key => $addon)
 		{
 			// get easyinstall remove url
 			$packageSrl = $oAutoinstallModel->getPackageSrlByPath($addon->path);
@@ -55,7 +55,7 @@ 
 			$addonList[$key]->need_update = $package[$packageSrl]->need_update;
 
 			// get easyinstall update url
-			if($addonList[$key]->need_update == 'Y')
+			if ($addonList[$key]->need_update == 'Y')
 			{
 				$addonList[$key]->update_url = $oAutoinstallModel->getUpdateUrlByPackageSrl($packageSrl);
 			}
@@ -78,7 +78,7 @@ 
 		// Downloaded and installed add-on to the list of Wanted
 		$searched_list = FileHandler::readDir('./addons', '/^([a-zA-Z0-9-_]+)$/');
 		$searched_count = count($searched_list);
-		if(!$searched_count)
+		if (!$searched_count)
 		{
 			return;
 		}
@@ -87,11 +87,11 @@ 
 
 		$oAddonAdminController = getAdminController('addon');
 
-		for($i = 0; $i < $searched_count; $i++)
+		for ($i = 0; $i < $searched_count; $i++)
 		{
 			// Add the name of
 			$addon_name = $searched_list[$i];
-			if($addon_name == "smartphone")
+			if ($addon_name == "smartphone")
 			{
 				continue;
 			}
@@ -100,7 +100,7 @@ 
 			// Wanted information on the add-on
 			$info = $this->getAddonInfoXml($addon_name, $site_srl, $gtype);
 			
-			if(!$info) $info = new stdClass();
+			if (!$info) $info = new stdClass();
 
 			$info->addon = $addon_name;
 			$info->path = $path;
@@ -108,7 +108,7 @@ 
 			$info->mactivated = FALSE;
 			$info->fixed = FALSE;
 			// Check if a permossion is granted entered in DB
-			if(!in_array($addon_name, array_keys($inserted_addons)))
+			if (!in_array($addon_name, array_keys($inserted_addons)))
 			{
 				// If not, type in the DB type (model, perhaps because of the hate doing this haneungeo .. ㅡ. ㅜ)
 				$oAddonAdminController->doInsert($addon_name, $site_srl, $type);
@@ -116,15 +116,15 @@ 
 			}
 			else
 			{
-				if($inserted_addons[$addon_name]->is_used == 'Y')
+				if ($inserted_addons[$addon_name]->is_used == 'Y')
 				{
 					$info->activated = TRUE;
 				}
-				if($inserted_addons[$addon_name]->is_used_m == 'Y')
+				if ($inserted_addons[$addon_name]->is_used_m == 'Y')
 				{
 					$info->mactivated = TRUE;
 				}
-				if($gtype == 'global' && $inserted_addons[$addon_name]->is_fixed == 'Y')
+				if ($gtype == 'global' && $inserted_addons[$addon_name]->is_fixed == 'Y')
 				{
 					$info->fixed = TRUE;
 				}
@@ -147,14 +147,14 @@ 
 	{
 		// Get a path of the requested module. Return if not exists.
 		$addon_path = $this->getAddonPath($addon);
-		if(!$addon_path)
+		if (!$addon_path)
 		{
 			return;
 		}
 
 		// Read the xml file for module skin information
 		$xml_file = sprintf("%sconf/info.xml", FileHandler::getRealpath($addon_path));
-		if(!file_exists($xml_file))
+		if (!file_exists($xml_file))
 		{
 			return;
 		}
@@ -163,7 +163,7 @@ 
 		$tmp_xml_obj = $oXmlParser->loadXmlFile($xml_file);
 		$xml_obj = $tmp_xml_obj->addon;
 
-		if(!$xml_obj)
+		if (!$xml_obj)
 		{
 			return;
 		}
@@ -171,7 +171,7 @@ 
 		// DB is set to bring history
 		$db_args = new stdClass();
 		$db_args->addon = $addon;
-		if($gtype == 'global')
+		if ($gtype == 'global')
 		{
 			$output = executeQuery('addon.getAddonInfo', $db_args);
 		}
@@ -183,7 +183,7 @@ 
 		$extra_vals = unserialize($output->data->extra_vars);
 
 		$addon_info = new stdClass();
-		if($extra_vals->mid_list)
+		if ($extra_vals->mid_list)
 		{
 			$addon_info->mid_list = $extra_vals->mid_list;
 		}
@@ -192,13 +192,13 @@ 
 			$addon_info->mid_list = array();
 		}
 
-		if($extra_vals->xe_run_method)
+		if ($extra_vals->xe_run_method)
 		{
 			$addon_info->xe_run_method = $extra_vals->xe_run_method;
 		}
 
 		// Add information
-		if($xml_obj->version && $xml_obj->attrs->version == '0.2')
+		if ($xml_obj->version && $xml_obj->attrs->version == '0.2')
 		{
 			// addon format v0.2
 			$date_obj = new stdClass();
@@ -213,7 +213,7 @@ 
 			$addon_info->license = $xml_obj->license->body;
 			$addon_info->license_link = $xml_obj->license->attrs->link;
 
-			if(!is_array($xml_obj->author))
+			if (!is_array($xml_obj->author))
 			{
 				$author_list = array();
 				$author_list[] = $xml_obj->author;
@@ -224,7 +224,7 @@ 
 			}
 
 			$addon_info->author = array();
-			foreach($author_list as $author)
+			foreach ($author_list as $author)
 			{
 				$author_obj = new stdClass();
 				$author_obj->name = $author->name->body;
@@ -234,39 +234,39 @@ 
 			}
 
 			// Expand the variable order
-			if($xml_obj->extra_vars)
+			if ($xml_obj->extra_vars)
 			{
 				$extra_var_groups = $xml_obj->extra_vars->group;
-				if(!$extra_var_groups)
+				if (!$extra_var_groups)
 				{
 					$extra_var_groups = $xml_obj->extra_vars;
 				}
-				if(!is_array($extra_var_groups))
+				if (!is_array($extra_var_groups))
 				{
 					$extra_var_groups = array($extra_var_groups);
 				}
 
-				foreach($extra_var_groups as $group)
+				foreach ($extra_var_groups as $group)
 				{
 					$extra_vars = $group->var;
-					if(!is_array($group->var))
+					if (!is_array($group->var))
 					{
 						$extra_vars = array($group->var);
 					}
 
-					foreach($extra_vars as $key => $val)
+					foreach ($extra_vars as $key => $val)
 					{
-						if(!$val)
+						if (!$val)
 						{
 							continue;
 						}
 
 						$obj = new stdClass();
-						if(!$val->attrs)
+						if (!$val->attrs)
 						{
 							$val->attrs = new stdClass();
 						}
-						if(!$val->attrs->type)
+						if (!$val->attrs->type)
 						{
 							$val->attrs->type = 'text';
 						}
@@ -276,26 +276,26 @@ 
 						$obj->title = $val->title->body;
 						$obj->type = $val->attrs->type;
 						$obj->description = $val->description->body;
-						if($obj->name)
+						if ($obj->name)
 						{
 							$obj->value = $extra_vals->{$obj->name};
 						}
-						if(strpos($obj->value, '|@|') != FALSE)
+						if (strpos($obj->value, '|@|') != FALSE)
 						{
 							$obj->value = explode('|@|', $obj->value);
 						}
-						if($obj->type == 'mid_list' && !is_array($obj->value))
+						if ($obj->type == 'mid_list' && !is_array($obj->value))
 						{
 							$obj->value = array($obj->value);
 						}
 
 						// 'Select'type obtained from the option list.
-						if($val->options && !is_array($val->options))
+						if ($val->options && !is_array($val->options))
 						{
 							$val->options = array($val->options);
 						}
 
-						for($i = 0, $c = count($val->options); $i < $c; $i++)
+						for ($i = 0, $c = count($val->options); $i < $c; $i++)
 						{
 							$obj->options[$i] = new stdClass();
 							$obj->options[$i]->title = $val->options[$i]->title->body;
@@ -328,30 +328,30 @@ 
 			$addon_info->author = array();
 			$addon_info->author[] = $author_obj;
 
-			if($xml_obj->extra_vars)
+			if ($xml_obj->extra_vars)
 			{
 				// Expand the variable order
 				$extra_var_groups = $xml_obj->extra_vars->group;
-				if(!$extra_var_groups)
+				if (!$extra_var_groups)
 				{
 					$extra_var_groups = $xml_obj->extra_vars;
 				}
-				if(!is_array($extra_var_groups))
+				if (!is_array($extra_var_groups))
 				{
 					$extra_var_groups = array($extra_var_groups);
 				}
-				foreach($extra_var_groups as $group)
+				foreach ($extra_var_groups as $group)
 				{
 					$extra_vars = $group->var;
-					if(!is_array($group->var))
+					if (!is_array($group->var))
 					{
 						$extra_vars = array($group->var);
 					}
 
 					$addon_info->extra_vars = array();
-					foreach($extra_vars as $key => $val)
+					foreach ($extra_vars as $key => $val)
 					{
-						if(!$val)
+						if (!$val)
 						{
 							continue;
 						}
@@ -363,26 +363,26 @@ 
 						$obj->title = $val->title->body;
 						$obj->type = $val->type->body ? $val->type->body : 'text';
 						$obj->description = $val->description->body;
-						if($obj->name)
+						if ($obj->name)
 						{
 							$obj->value = $extra_vals->{$obj->name};
 						}
-						if(strpos($obj->value, '|@|') != false)
+						if (strpos($obj->value, '|@|') != false)
 						{
 							$obj->value = explode('|@|', $obj->value);
 						}
-						if($obj->type == 'mid_list' && !is_array($obj->value))
+						if ($obj->type == 'mid_list' && !is_array($obj->value))
 						{
 							$obj->value = array($obj->value);
 						}
 						// 'Select'type obtained from the option list.
-						if($val->options && !is_array($val->options))
+						if ($val->options && !is_array($val->options))
 						{
 							$val->options = array($val->options);
 						}
 
 						$obj->options = array();
-						for($i = 0, $c = count($val->options); $i < $c; $i++)
+						for ($i = 0, $c = count($val->options); $i < $c; $i++)
 						{
 							$obj->options[$i]->title = $val->options[$i]->title->body;
 							$obj->options[$i]->value = $val->options[$i]->value->body;
@@ -406,7 +406,7 @@ 
 	{
 		$args = new stdClass();
 		$args->list_order = 'addon';
-		if($gtype == 'global')
+		if ($gtype == 'global')
 		{
 			$output = executeQueryArray('addon.getAddons', $args);
 		}
@@ -415,14 +415,14 @@ 
 			$args->site_srl = $site_srl;
 			$output = executeQueryArray('addon.getSiteAddons', $args);
 		}
-		if(!$output->data)
+		if (!$output->data)
 		{
 			return array();
 		}
 
 		$activated_count = count($output->data);
 		$addon_list = array();
-		for($i = 0; $i < $activated_count; $i++)
+		for ($i = 0; $i < $activated_count; $i++)
 		{
 			$addon = $output->data[$i];
 			$addon_list[$addon->addon] = $addon;
@@ -443,9 +443,9 @@ 
 	{
 		$args = new stdClass();
 		$args->addon = $addon;
-		if($gtype == 'global')
+		if ($gtype == 'global')
 		{
-			if($type == "pc")
+			if ($type == "pc")
 			{
 				$output = executeQuery('addon.getAddonIsActivated', $args);
 			}
@@ -457,7 +457,7 @@ 
 		else
 		{
 			$args->site_srl = $site_srl;
-			if($type == "pc")
+			if ($type == "pc")
 			{
 				$output = executeQuery('addon.getSiteAddonIsActivated', $args);
 			}
@@ -466,7 +466,7 @@ 
 				$output = executeQuery('addon.getSiteMAddonIsActivated', $args);
 			}
 		}
-		if($output->data->count > 0)
+		if ($output->data->count > 0)
 		{
 			return TRUE;
 		}

Braces +12 added lines, -19 removed lines

@@ -100,7 +100,9 @@ 
 			// Wanted information on the add-on
 			$info = $this->getAddonInfoXml($addon_name, $site_srl, $gtype);
 			
-			if(!$info) $info = new stdClass();
+			if(!$info) {
+				$info = new stdClass();
+			}
 
 			$info->addon = $addon_name;
 			$info->path = $path;
@@ -113,8 +115,7 @@ 
 				// If not, type in the DB type (model, perhaps because of the hate doing this haneungeo .. ㅡ. ㅜ)
 				$oAddonAdminController->doInsert($addon_name, $site_srl, $type);
 				// Is activated
-			}
-			else
+			} else
 			{
 				if($inserted_addons[$addon_name]->is_used == 'Y')
 				{
@@ -174,8 +175,7 @@ 
 		if($gtype == 'global')
 		{
 			$output = executeQuery('addon.getAddonInfo', $db_args);
-		}
-		else
+		} else
 		{
 			$db_args->site_srl = $site_srl;
 			$output = executeQuery('addon.getSiteAddonInfo', $db_args);
@@ -186,8 +186,7 @@ 
 		if($extra_vals->mid_list)
 		{
 			$addon_info->mid_list = $extra_vals->mid_list;
-		}
-		else
+		} else
 		{
 			$addon_info->mid_list = array();
 		}
@@ -217,8 +216,7 @@ 
 			{
 				$author_list = array();
 				$author_list[] = $xml_obj->author;
-			}
-			else
+			} else
 			{
 				$author_list = $xml_obj->author;
 			}
@@ -306,8 +304,7 @@ 
 					}
 				}
 			}
-		}
-		else
+		} else
 		{
 			// addon format 0.1
 			$addon_info = new stdClass();
@@ -409,8 +406,7 @@ 
 		if($gtype == 'global')
 		{
 			$output = executeQueryArray('addon.getAddons', $args);
-		}
-		else
+		} else
 		{
 			$args->site_srl = $site_srl;
 			$output = executeQueryArray('addon.getSiteAddons', $args);
@@ -448,20 +444,17 @@ 
 			if($type == "pc")
 			{
 				$output = executeQuery('addon.getAddonIsActivated', $args);
-			}
-			else
+			} else
 			{
 				$output = executeQuery('addon.getMAddonIsActivated', $args);
 			}
-		}
-		else
+		} else
 		{
 			$args->site_srl = $site_srl;
 			if($type == "pc")
 			{
 				$output = executeQuery('addon.getSiteAddonIsActivated', $args);
-			}
-			else
+			} else
 			{
 				$output = executeQuery('addon.getSiteMAddonIsActivated', $args);
 			}

modules/admin/admin.admin.controller.php

Doc Comments +8 added lines, -3 removed lines

@@ -13,7 +13,7 @@ 
 
 	/**
 	 * initialization
-	 * @return void
+	 * @return ModuleObject|null
 	 */
 	function init()
 	{
@@ -52,7 +52,7 @@ 
 
 	/**
 	 * Regenerate all cache files
-	 * @return void
+	 * @return Object|null
 	 */
 	function procAdminRecompileCacheFile()
 	{
@@ -207,6 +207,9 @@ 
 		return new Object();
 	}
 
+	/**
+	 * @param stdClass $designInfo
+	 */
 	function makeDefaultDesignFile($designInfo, $site_srl = 0)
 	{
 		$buff = array();
@@ -433,6 +436,8 @@ 
 
 	/**
 	 * Insert favorite
+	 * @param string $siteSrl
+	 * @param string $module
 	 * @return object query result
 	 */
 	function _insertFavorite($siteSrl, $module, $type = 'module')
@@ -471,7 +476,7 @@ 
 
 	/**
 	 * Remove admin icon
-	 * @return object|void
+	 * @return Object|null
 	 */
 	function procAdminRemoveIcons()
 	{

Braces +15 added lines, -15 removed lines

@@ -181,8 +181,7 @@ 
 		if(is_readable($siteDesignFile))
 		{
 			include($siteDesignFile);
-		}
-		else
+		} else
 		{
 			$designInfo = new stdClass();
 		}
@@ -198,7 +197,9 @@ 
 				$moduleName = 'page';
 			}
 
-			if(!isset($designInfo->module->{$moduleName})) $designInfo->module->{$moduleName} = new stdClass();
+			if(!isset($designInfo->module->{$moduleName})) {
+				$designInfo->module->{$moduleName} = new stdClass();
+			}
 			$designInfo->module->{$moduleName}->{$skinTarget} = $skinName;
 		}
 
@@ -337,8 +338,7 @@ 
 		if($isAgree == 'true')
 		{
 			$_SESSION['enviroment_gather'] = 'Y';
-		}
-		else
+		} else
 		{
 			$_SESSION['enviroment_gather'] = 'N';
 		}
@@ -374,12 +374,10 @@ 
 			if($type == 3)
 			{
 				$ext = 'png';
-			}
-			elseif($type == 2)
+			} elseif($type == 2)
 			{
 				$ext = 'jpg';
-			}
-			else
+			} else
 			{
 				$ext = 'gif';
 			}
@@ -392,8 +390,7 @@ 
 		if($adminTitle)
 		{
 			$oAdminConfig->adminTitle = strip_tags($adminTitle);
-		}
-		else
+		} else
 		{
 			unset($oAdminConfig->adminTitle);
 		}
@@ -488,8 +485,7 @@ 
 		if($file_exist)
 		{
 			@FileHandler::removeFile(_XE_PATH_ . 'files/attach/xeicon/' . $virtual_site . $iconname);
-		}
-		else
+		} else
 		{
 			return new Object(-1, 'fail_to_delete');
 		}
@@ -533,7 +529,9 @@ 
 		if(!in_array(Context::getRequestMethod(), array('XMLRPC','JSON')))
 		{
 			$returnUrl = Context::get('success_return_url');
-			if(!$returnUrl) $returnUrl = getNotEncodedUrl('', 'act', 'dispAdminConfigGeneral');
+			if(!$returnUrl) {
+				$returnUrl = getNotEncodedUrl('', 'act', 'dispAdminConfigGeneral');
+			}
 			header('location:' . $returnUrl);
 			return;
 		}
@@ -577,7 +575,9 @@ 
 		if(!in_array(Context::getRequestMethod(), array('XMLRPC','JSON')))
 		{
 			$returnUrl = Context::get('success_return_url');
-			if(!$returnUrl) $returnUrl = getNotEncodedUrl('', 'act', 'dispAdminConfigGeneral');
+			if(!$returnUrl) {
+				$returnUrl = getNotEncodedUrl('', 'act', 'dispAdminConfigGeneral');
+			}
 			header('location:' . $returnUrl);
 			return;
 		}

Spacing +72 added lines, -72 removed lines

@@ -20,7 +20,7 @@ 
 		// forbit access if the user is not an administrator
 		$oMemberModel = getModel('member');
 		$logged_info = $oMemberModel->getLoggedInfo();
-		if($logged_info->is_admin != 'Y')
+		if ($logged_info->is_admin != 'Y')
 		{
 			return $this->stop("msg_is_not_administrator");
 		}
@@ -33,14 +33,14 @@ 
 	function procAdminMenuReset()
 	{
 		$menuSrl = Context::get('menu_srl');
-		if(!$menuSrl)
+		if (!$menuSrl)
 		{
 			return $this->stop('msg_invalid_request');
 		}
 
 		$oMenuAdminController = getAdminController('menu');
 		$output = $oMenuAdminController->deleteMenu($menuSrl);
-		if(!$output->toBool())
+		if (!$output->toBool())
 		{
 			return $output;
 		}
@@ -57,27 +57,27 @@ 
 	function procAdminRecompileCacheFile()
 	{
 		// rename cache dir
-		$temp_cache_dir = './files/cache_' . $_SERVER['REQUEST_TIME'];
+		$temp_cache_dir = './files/cache_'.$_SERVER['REQUEST_TIME'];
 		FileHandler::rename('./files/cache', $temp_cache_dir);
 		FileHandler::makeDir('./files/cache');
 
 		// remove module extend cache
-		FileHandler::removeFile(_XE_PATH_ . 'files/config/module_extend.php');
+		FileHandler::removeFile(_XE_PATH_.'files/config/module_extend.php');
 
 		// remove debug files
-		FileHandler::removeFile(_XE_PATH_ . 'files/_debug_message.php');
-		FileHandler::removeFile(_XE_PATH_ . 'files/_debug_db_query.php');
-		FileHandler::removeFile(_XE_PATH_ . 'files/_db_slow_query.php');
+		FileHandler::removeFile(_XE_PATH_.'files/_debug_message.php');
+		FileHandler::removeFile(_XE_PATH_.'files/_debug_db_query.php');
+		FileHandler::removeFile(_XE_PATH_.'files/_db_slow_query.php');
 
 		$oModuleModel = getModel('module');
 		$module_list = $oModuleModel->getModuleList();
 
 		// call recompileCache for each module
-		foreach($module_list as $module)
+		foreach ($module_list as $module)
 		{
 			$oModule = NULL;
 			$oModule = getClass($module->module);
-			if(method_exists($oModule, 'recompileCache'))
+			if (method_exists($oModule, 'recompileCache'))
 			{
 				$oModule->recompileCache();
 			}
@@ -88,37 +88,37 @@ 
 		$oObjectCacheHandler = CacheHandler::getInstance('object');
 		$oTemplateCacheHandler = CacheHandler::getInstance('template');
 
-		if($oObjectCacheHandler->isSupport())
+		if ($oObjectCacheHandler->isSupport())
 		{
 			$truncated[] = $oObjectCacheHandler->truncate();
 		}
 
-		if($oTemplateCacheHandler->isSupport())
+		if ($oTemplateCacheHandler->isSupport())
 		{
 			$truncated[] = $oTemplateCacheHandler->truncate();
 		}
 
-		if(count($truncated) && in_array(FALSE, $truncated))
+		if (count($truncated) && in_array(FALSE, $truncated))
 		{
 			return new Object(-1, 'msg_self_restart_cache_engine');
 		}
 
 		// remove cache dir
 		$tmp_cache_list = FileHandler::readDir('./files', '/(^cache_[0-9]+)/');
-		if($tmp_cache_list)
+		if ($tmp_cache_list)
 		{
-			foreach($tmp_cache_list as $tmp_dir)
+			foreach ($tmp_cache_list as $tmp_dir)
 			{
-				if($tmp_dir)
+				if ($tmp_dir)
 				{
-					FileHandler::removeDir('./files/' . $tmp_dir);
+					FileHandler::removeDir('./files/'.$tmp_dir);
 				}
 			}
 		}
 
 		// remove duplicate indexes (only for CUBRID)
 		$db_type = Context::getDBType();
-		if($db_type == 'cubrid')
+		if ($db_type == 'cubrid')
 		{
 			$db = DB::getInstance();
 			$db->deleteDuplicateIndexes();
@@ -140,13 +140,13 @@ 
 		$oMemberController = getController('member');
 		$oMemberController->procMemberLogout();
 
-		header('Location: ' . getNotEncodedUrl('', 'module', 'admin'));
+		header('Location: '.getNotEncodedUrl('', 'module', 'admin'));
 	}
 
 	public function procAdminInsertDefaultDesignInfo()
 	{
 		$vars = Context::getRequestVars();
-		if(!$vars->site_srl)
+		if (!$vars->site_srl)
 		{
 			$vars->site_srl = 0;
 		}
@@ -158,27 +158,27 @@ 
 
 	public function updateDefaultDesignInfo($vars)
 	{
-		$siteDesignPath = _XE_PATH_ . 'files/site_design/';
+		$siteDesignPath = _XE_PATH_.'files/site_design/';
 
 		$vars->module_skin = json_decode($vars->module_skin);
 
-		if(!is_dir($siteDesignPath))
+		if (!is_dir($siteDesignPath))
 		{
 			FileHandler::makeDir($siteDesignPath);
 		}
 
-		$siteDesignFile = _XE_PATH_ . 'files/site_design/design_' . $vars->site_srl . '.php';
+		$siteDesignFile = _XE_PATH_.'files/site_design/design_'.$vars->site_srl.'.php';
 
 		$layoutTarget = 'layout_srl';
 		$skinTarget = 'skin';
 
-		if($vars->target_type == 'M')
+		if ($vars->target_type == 'M')
 		{
 			$layoutTarget = 'mlayout_srl';
 			$skinTarget = 'mskin';
 		}
 
-		if(is_readable($siteDesignFile))
+		if (is_readable($siteDesignFile))
 		{
 			include($siteDesignFile);
 		}
@@ -191,14 +191,14 @@ 
 
 		$designInfo->{$layoutTarget} = $layoutSrl;
 
-		foreach($vars->module_skin as $moduleName => $skinName)
+		foreach ($vars->module_skin as $moduleName => $skinName)
 		{
-			if($moduleName == 'ARTICLE')
+			if ($moduleName == 'ARTICLE')
 			{
 				$moduleName = 'page';
 			}
 
-			if(!isset($designInfo->module->{$moduleName})) $designInfo->module->{$moduleName} = new stdClass();
+			if (!isset($designInfo->module->{$moduleName})) $designInfo->module->{$moduleName} = new stdClass();
 			$designInfo->module->{$moduleName}->{$skinTarget} = $skinName;
 		}
 
@@ -213,28 +213,28 @@ 
 		$buff[] = '<?php if(!defined("__XE__")) exit();';
 		$buff[] = '$designInfo = new stdClass;';
 
-		if($designInfo->layout_srl)
+		if ($designInfo->layout_srl)
 		{
 			$buff[] = sprintf('$designInfo->layout_srl = %s; ', $designInfo->layout_srl);
 		}
 
-		if($designInfo->mlayout_srl)
+		if ($designInfo->mlayout_srl)
 		{
 			$buff[] = sprintf('$designInfo->mlayout_srl = %s;', $designInfo->mlayout_srl);
 		}
 
 		$buff[] = '$designInfo->module = new stdClass;';
 
-		foreach($designInfo->module as $moduleName => $skinInfo)
+		foreach ($designInfo->module as $moduleName => $skinInfo)
 		{
 			$buff[] = sprintf('$designInfo->module->%s = new stdClass;', $moduleName);
-			foreach($skinInfo as $target => $skinName)
+			foreach ($skinInfo as $target => $skinName)
 			{
 				$buff[] = sprintf('$designInfo->module->%s->%s = \'%s\';', $moduleName, $target, $skinName);
 			}
 		}
 
-		$siteDesignFile = _XE_PATH_ . 'files/site_design/design_' . $site_srl . '.php';
+		$siteDesignFile = _XE_PATH_.'files/site_design/design_'.$site_srl.'.php';
 		FileHandler::writeFile($siteDesignFile, implode(PHP_EOL, $buff));
 	}
 
@@ -250,13 +250,13 @@ 
 		// check favorite exists
 		$oModel = getAdminModel('admin');
 		$output = $oModel->isExistsFavorite($siteSrl, $moduleName);
-		if(!$output->toBool())
+		if (!$output->toBool())
 		{
 			return $output;
 		}
 
 		// if exists, delete favorite
-		if($output->get('result'))
+		if ($output->get('result'))
 		{
 			$favoriteSrl = $output->get('favoriteSrl');
 			$output = $this->_deleteFavorite($favoriteSrl);
@@ -269,7 +269,7 @@ 
 			$result = 'on';
 		}
 
-		if(!$output->toBool())
+		if (!$output->toBool())
 		{
 			return $output;
 		}
@@ -287,31 +287,31 @@ 
 	{
 		$oModel = getAdminModel('admin');
 		$output = $oModel->getFavoriteList();
-		if(!$output->toBool())
+		if (!$output->toBool())
 		{
 			return $output;
 		}
 
 		$favoriteList = $output->get('favoriteList');
-		if(!$favoriteList)
+		if (!$favoriteList)
 		{
 			return new Object();
 		}
 
 		$deleteTargets = array();
-		foreach($favoriteList as $favorite)
+		foreach ($favoriteList as $favorite)
 		{
-			if($favorite->type == 'module')
+			if ($favorite->type == 'module')
 			{
-				$modulePath = _XE_PATH_ . 'modules/' . $favorite->module;
-				if(!is_dir($modulePath))
+				$modulePath = _XE_PATH_.'modules/'.$favorite->module;
+				if (!is_dir($modulePath))
 				{
 					$deleteTargets[] = $favorite->admin_favorite_srl;
 				}
 			}
 		}
 
-		if(!count($deleteTargets))
+		if (!count($deleteTargets))
 		{
 			return new Object();
 		}
@@ -319,7 +319,7 @@ 
 		$args = new stdClass();
 		$args->admin_favorite_srls = $deleteTargets;
 		$output = executeQuery('admin.deleteFavorites', $args);
-		if(!$output->toBool())
+		if (!$output->toBool())
 		{
 			return $output;
 		}
@@ -334,7 +334,7 @@ 
 	function procAdminEnviromentGatheringAgreement()
 	{
 		$isAgree = Context::get('is_agree');
-		if($isAgree == 'true')
+		if ($isAgree == 'true')
 		{
 			$_SESSION['enviroment_gather'] = 'Y';
 		}
@@ -359,23 +359,23 @@ 
 		$oModuleModel = getModel('module');
 		$oAdminConfig = $oModuleModel->getModuleConfig('admin');
 
-		if(!is_object($oAdminConfig))
+		if (!is_object($oAdminConfig))
 		{
 			$oAdminConfig = new stdClass();
 		}
 
-		if($file['tmp_name'])
+		if ($file['tmp_name'])
 		{
 			$target_path = 'files/attach/images/admin/';
 			FileHandler::makeDir($target_path);
 
 			// Get file information
 			list($width, $height, $type, $attrs) = @getimagesize($file['tmp_name']);
-			if($type == 3)
+			if ($type == 3)
 			{
 				$ext = 'png';
 			}
-			elseif($type == 2)
+			elseif ($type == 2)
 			{
 				$ext = 'jpg';
 			}
@@ -389,7 +389,7 @@ 
 
 			$oAdminConfig->adminLogo = $target_filename;
 		}
-		if($adminTitle)
+		if ($adminTitle)
 		{
 			$oAdminConfig->adminTitle = strip_tags($adminTitle);
 		}
@@ -398,7 +398,7 @@ 
 			unset($oAdminConfig->adminTitle);
 		}
 
-		if($oAdminConfig)
+		if ($oAdminConfig)
 		{
 			$oModuleController = getController('module');
 			$oModuleController->insertModuleConfig('admin', $oAdminConfig);
@@ -419,7 +419,7 @@ 
 		$oModuleModel = getModel('module');
 		$oAdminConfig = $oModuleModel->getModuleConfig('admin');
 
-		FileHandler::removeFile(_XE_PATH_ . $oAdminConfig->adminLogo);
+		FileHandler::removeFile(_XE_PATH_.$oAdminConfig->adminLogo);
 		unset($oAdminConfig->adminLogo);
 
 		$oModuleController = getController('module');
@@ -478,16 +478,16 @@ 
 
 		$site_info = Context::get('site_module_info');
 		$virtual_site = '';
-		if($site_info->site_srl) 
+		if ($site_info->site_srl) 
 		{
-			$virtual_site = $site_info->site_srl . '/';
+			$virtual_site = $site_info->site_srl.'/';
 		}
 
 		$iconname = Context::get('iconname');
-		$file_exist = FileHandler::readFile(_XE_PATH_ . 'files/attach/xeicon/' . $virtual_site . $iconname);
-		if($file_exist)
+		$file_exist = FileHandler::readFile(_XE_PATH_.'files/attach/xeicon/'.$virtual_site.$iconname);
+		if ($file_exist)
 		{
-			@FileHandler::removeFile(_XE_PATH_ . 'files/attach/xeicon/' . $virtual_site . $iconname);
+			@FileHandler::removeFile(_XE_PATH_.'files/attach/xeicon/'.$virtual_site.$iconname);
 		}
 		else
 		{
@@ -508,33 +508,33 @@ 
 		$db_info->sitelock_message = $vars->sitelock_message;
 
 		$whitelist = $vars->sitelock_whitelist;
-		$whitelist = preg_replace("/[\r|\n|\r\n]+/",",",$whitelist);
-		$whitelist = preg_replace("/\s+/","",$whitelist);
-		if(preg_match('/(<\?|<\?php|\?>)/xsm', $whitelist))
+		$whitelist = preg_replace("/[\r|\n|\r\n]+/", ",", $whitelist);
+		$whitelist = preg_replace("/\s+/", "", $whitelist);
+		if (preg_match('/(<\?|<\?php|\?>)/xsm', $whitelist))
 		{
 			$whitelist = '';
 		}
-		$whitelist .= ',127.0.0.1,' . $_SERVER['REMOTE_ADDR'];
-		$whitelist = explode(',',trim($whitelist, ','));
+		$whitelist .= ',127.0.0.1,'.$_SERVER['REMOTE_ADDR'];
+		$whitelist = explode(',', trim($whitelist, ','));
 		$whitelist = array_unique($whitelist);
 
-		if(!IpFilter::validate($whitelist)) {
+		if (!IpFilter::validate($whitelist)) {
 			return new Object(-1, 'msg_invalid_ip');
 		}
 
 		$db_info->sitelock_whitelist = $whitelist;
 
 		$oInstallController = getController('install');
-		if(!$oInstallController->makeConfigFile())
+		if (!$oInstallController->makeConfigFile())
 		{
 			return new Object(-1, 'msg_invalid_request');
 		}
 
-		if(!in_array(Context::getRequestMethod(), array('XMLRPC','JSON')))
+		if (!in_array(Context::getRequestMethod(), array('XMLRPC', 'JSON')))
 		{
 			$returnUrl = Context::get('success_return_url');
-			if(!$returnUrl) $returnUrl = getNotEncodedUrl('', 'act', 'dispAdminConfigGeneral');
-			header('location:' . $returnUrl);
+			if (!$returnUrl) $returnUrl = getNotEncodedUrl('', 'act', 'dispAdminConfigGeneral');
+			header('location:'.$returnUrl);
 			return;
 		}
 	}
@@ -565,20 +565,20 @@ 
 		$db_info->embed_white_iframe = $white_iframe;
 
 		$oInstallController = getController('install');
-		if(!$oInstallController->makeConfigFile())
+		if (!$oInstallController->makeConfigFile())
 		{
 			return new Object(-1, 'msg_invalid_request');
 		}
 
-		require_once(_XE_PATH_ . 'classes/security/EmbedFilter.class.php');
+		require_once(_XE_PATH_.'classes/security/EmbedFilter.class.php');
 		$oEmbedFilter = EmbedFilter::getInstance();
 		$oEmbedFilter->_makeWhiteDomainList($whitelist);
 
-		if(!in_array(Context::getRequestMethod(), array('XMLRPC','JSON')))
+		if (!in_array(Context::getRequestMethod(), array('XMLRPC', 'JSON')))
 		{
 			$returnUrl = Context::get('success_return_url');
-			if(!$returnUrl) $returnUrl = getNotEncodedUrl('', 'act', 'dispAdminConfigGeneral');
-			header('location:' . $returnUrl);
+			if (!$returnUrl) $returnUrl = getNotEncodedUrl('', 'act', 'dispAdminConfigGeneral');
+			header('location:'.$returnUrl);
 			return;
 		}
 	}

modules/admin/admin.admin.model.php

Doc Comments +8 added lines, -2 removed lines

@@ -275,7 +275,7 @@ 
 
 	/**
 	 * Add file list to Object after sftp connect
-	 * @return void|Object
+	 * @return Object|null
 	 */
 	function getSFTPList()
 	{
@@ -316,7 +316,7 @@ 
 
 	/**
 	 * Add file list to Object after ftp connect
-	 * @return void|Object
+	 * @return Object|null
 	 */
 	function getAdminFTPList()
 	{
@@ -867,6 +867,7 @@ 
 	 * Returns a list of all sites that contain modules
 	 * For each site domain and site_srl are retrieved
 	 *
+	 * @param string $domain
 	 * @return array
 	 */
 	function getAllSitesThatHaveModules($domain = NULL)
@@ -945,6 +946,11 @@ 
 		return $this->iconUrlCheck('mobicon.png', 'mobiconSample.png', $default);
 	}
 
+	/**
+	 * @param string $iconname
+	 * @param string $default_icon_name
+	 * @param boolean $default
+	 */
 	function iconUrlCheck($iconname, $default_icon_name, $default)
 	{
 		$site_info = Context::get('site_module_info');

Indentation +4 added lines, -4 removed lines

@@ -956,10 +956,10 @@
 
 		$file_exsit = FileHandler::readFile(_XE_PATH_ . 'files/attach/xeicon/' . $virtual_site . $iconname);
 		if(!$file_exsit && $default === true)
-        {
-            $icon_url = './modules/admin/tpl/img/' . $default_icon_name;
-        }
-        elseif($file_exsit)
+		{
+			$icon_url = './modules/admin/tpl/img/' . $default_icon_name;
+		}
+		elseif($file_exsit)
 		{
 			$default_url = Context::getDefaultUrl();
 			if($default_url && substr_compare($default_url, '/', -1) === 0) $default_url = substr($default_url, 0, -1);

Spacing +140 added lines, -140 removed lines

@@ -30,18 +30,18 @@ 
 	{
 		$ftp_info = Context::getRequestVars();
 
-		if(!$ftp_info->ftp_host)
+		if (!$ftp_info->ftp_host)
 		{
 			$ftp_info->ftp_host = "127.0.0.1";
 		}
 
-		if(!$ftp_info->ftp_port || !is_numeric($ftp_info->ftp_port))
+		if (!$ftp_info->ftp_port || !is_numeric($ftp_info->ftp_port))
 		{
 			$ftp_info->ftp_port = '22';
 		}
 
 		$connection = ssh2_connect($ftp_info->ftp_host, $ftp_info->ftp_port);
-		if(!ssh2_auth_password($connection, $ftp_info->ftp_user, $ftp_info->ftp_password))
+		if (!ssh2_auth_password($connection, $ftp_info->ftp_user, $ftp_info->ftp_password))
 		{
 			return new Object(-1, 'msg_ftp_invalid_auth_info');
 		}
@@ -58,29 +58,29 @@ 
 		$path_candidate = array();
 
 		$temp = '';
-		foreach($path_info as $path)
+		foreach ($path_info as $path)
 		{
-			$temp = '/' . $path . $temp;
+			$temp = '/'.$path.$temp;
 			$path_candidate[] = $temp;
 		}
 
 		// try
-		foreach($path_candidate as $path)
+		foreach ($path_candidate as $path)
 		{
 			// upload check file
-			if(!@ssh2_scp_send($connection, FileHandler::getRealPath('./files/cache/ftp_check'), $path . 'ftp_check.html'))
+			if (!@ssh2_scp_send($connection, FileHandler::getRealPath('./files/cache/ftp_check'), $path.'ftp_check.html'))
 			{
 				continue;
 			}
 
 			// get check file
-			$result = FileHandler::getRemoteResource(getNotencodedFullUrl() . 'ftp_check.html');
+			$result = FileHandler::getRemoteResource(getNotencodedFullUrl().'ftp_check.html');
 
 			// delete temp check file
-			@ssh2_sftp_unlink($sftp, $path . 'ftp_check.html');
+			@ssh2_sftp_unlink($sftp, $path.'ftp_check.html');
 
 			// found
-			if($result == $pin)
+			if ($result == $pin)
 			{
 				$found_path = $path;
 				break;
@@ -89,7 +89,7 @@ 
 
 		FileHandler::removeFile('./files/cache/ftp_check', $pin);
 
-		if($found_path)
+		if ($found_path)
 		{
 			$this->add('found_path', $found_path);
 		}
@@ -99,24 +99,24 @@ 
 	{
 		$ftp_info = Context::getRequestVars();
 
-		if(!$ftp_info->ftp_host)
+		if (!$ftp_info->ftp_host)
 		{
 			$ftp_info->ftp_host = "127.0.0.1";
 		}
 
-		if(!$ftp_info->ftp_port || !is_numeric($ftp_info->ftp_port))
+		if (!$ftp_info->ftp_port || !is_numeric($ftp_info->ftp_port))
 		{
 			$ftp_info->ftp_port = '22';
 		}
 
 		$connection = ftp_connect($ftp_info->ftp_host, $ftp_info->ftp_port);
-		if(!$connection)
+		if (!$connection)
 		{
 			return new Object(-1, sprintf(Context::getLang('msg_ftp_not_connected'), 'host'));
 		}
 
 		$login_result = @ftp_login($connection, $ftp_info->ftp_user, $ftp_info->ftp_password);
-		if(!$login_result)
+		if (!$login_result)
 		{
 			ftp_close($connection);
 			return new Object(-1, 'msg_ftp_invalid_auth_info');
@@ -133,29 +133,29 @@ 
 		$path_candidate = array();
 
 		$temp = '';
-		foreach($path_info as $path)
+		foreach ($path_info as $path)
 		{
-			$temp = '/' . $path . $temp;
+			$temp = '/'.$path.$temp;
 			$path_candidate[] = $temp;
 		}
 
 		// try
-		foreach($path_candidate as $path)
+		foreach ($path_candidate as $path)
 		{
 			// upload check file
-			if(!ftp_put($connection, $path . 'ftp_check.html', FileHandler::getRealPath('./files/cache/ftp_check'), FTP_BINARY))
+			if (!ftp_put($connection, $path.'ftp_check.html', FileHandler::getRealPath('./files/cache/ftp_check'), FTP_BINARY))
 			{
 				continue;
 			}
 
 			// get check file
-			$result = FileHandler::getRemoteResource(getNotencodedFullUrl() . 'ftp_check.html');
+			$result = FileHandler::getRemoteResource(getNotencodedFullUrl().'ftp_check.html');
 
 			// delete temp check file
-			ftp_delete($connection, $path . 'ftp_check.html');
+			ftp_delete($connection, $path.'ftp_check.html');
 
 			// found
-			if($result == $pin)
+			if ($result == $pin)
 			{
 				$found_path = $path;
 				break;
@@ -164,7 +164,7 @@ 
 
 		FileHandler::removeFile('./files/cache/ftp_check', $pin);
 
-		if($found_path)
+		if ($found_path)
 		{
 			$this->add('found_path', $found_path);
 		}
@@ -175,39 +175,39 @@ 
 	 */
 	function getAdminFTPPath()
 	{
-		Context::loadLang(_XE_PATH_ . 'modules/autoinstall/lang');
+		Context::loadLang(_XE_PATH_.'modules/autoinstall/lang');
 		@set_time_limit(5);
-		require_once(_XE_PATH_ . 'libs/ftp.class.php');
+		require_once(_XE_PATH_.'libs/ftp.class.php');
 
 		$ftp_info = Context::getRequestVars();
 
-		if(!$ftp_info->ftp_user || !$ftp_info->ftp_password)
+		if (!$ftp_info->ftp_user || !$ftp_info->ftp_password)
 		{
 			return new Object(1, 'msg_ftp_invalid_auth_info');
 		}
 
-		if(!$ftp_info->ftp_host)
+		if (!$ftp_info->ftp_host)
 		{
 			$ftp_info->ftp_host = '127.0.0.1';
 		}
 
-		if(!$ftp_info->ftp_port || !is_numeric($ftp_info->ftp_port))
+		if (!$ftp_info->ftp_port || !is_numeric($ftp_info->ftp_port))
 		{
 			$ftp_info->ftp_port = '21';
 		}
 
-		if($ftp_info->sftp == 'Y')
+		if ($ftp_info->sftp == 'Y')
 		{
-			if(!function_exists('ssh2_sftp'))
+			if (!function_exists('ssh2_sftp'))
 			{
 				return new Object(-1, 'disable_sftp_support');
 			}
 			return $this->getSFTPPath();
 		}
 
-		if($ftp_info->ftp_pasv == 'N')
+		if ($ftp_info->ftp_pasv == 'N')
 		{
-			if(function_exists('ftp_connect'))
+			if (function_exists('ftp_connect'))
 			{
 				return $this->getFTPPath();
 			}
@@ -215,12 +215,12 @@ 
 		}
 
 		$oFTP = new ftp();
-		if(!$oFTP->ftp_connect($ftp_info->ftp_host, $ftp_info->ftp_port))
+		if (!$oFTP->ftp_connect($ftp_info->ftp_host, $ftp_info->ftp_port))
 		{
 			return new Object(1, sprintf(Context::getLang('msg_ftp_not_connected'), 'host'));
 		}
 
-		if(!$oFTP->ftp_login($ftp_info->ftp_user, $ftp_info->ftp_password))
+		if (!$oFTP->ftp_login($ftp_info->ftp_user, $ftp_info->ftp_password))
 		{
 			return new Object(1, 'msg_ftp_invalid_auth_info');
 		}
@@ -236,29 +236,29 @@ 
 		$path_candidate = array();
 
 		$temp = '';
-		foreach($path_info as $path)
+		foreach ($path_info as $path)
 		{
-			$temp = '/' . $path . $temp;
+			$temp = '/'.$path.$temp;
 			$path_candidate[] = $temp;
 		}
 
 		// try
-		foreach($path_candidate as $path)
+		foreach ($path_candidate as $path)
 		{
 			// upload check file
-			if(!$oFTP->ftp_put($path . 'ftp_check.html', FileHandler::getRealPath('./files/cache/ftp_check')))
+			if (!$oFTP->ftp_put($path.'ftp_check.html', FileHandler::getRealPath('./files/cache/ftp_check')))
 			{
 				continue;
 			}
 
 			// get check file
-			$result = FileHandler::getRemoteResource(getNotencodedFullUrl() . 'ftp_check.html');
+			$result = FileHandler::getRemoteResource(getNotencodedFullUrl().'ftp_check.html');
 
 			// delete temp check file
-			$oFTP->ftp_delete($path . 'ftp_check.html');
+			$oFTP->ftp_delete($path.'ftp_check.html');
 
 			// found
-			if($result == $pin)
+			if ($result == $pin)
 			{
 				$found_path = $path;
 				break;
@@ -267,7 +267,7 @@ 
 
 		FileHandler::removeFile('./files/cache/ftp_check', $pin);
 
-		if($found_path)
+		if ($found_path)
 		{
 			$this->add('found_path', $found_path);
 		}
@@ -280,27 +280,27 @@ 
 	function getSFTPList()
 	{
 		$ftp_info = Context::getRequestVars();
-		if(!$ftp_info->ftp_host)
+		if (!$ftp_info->ftp_host)
 		{
 			$ftp_info->ftp_host = "127.0.0.1";
 		}
 		$connection = ssh2_connect($ftp_info->ftp_host, $ftp_info->ftp_port);
-		if(!ssh2_auth_password($connection, $ftp_info->ftp_user, $ftp_info->ftp_password))
+		if (!ssh2_auth_password($connection, $ftp_info->ftp_user, $ftp_info->ftp_password))
 		{
 			return new Object(-1, 'msg_ftp_invalid_auth_info');
 		}
 
 		$sftp = ssh2_sftp($connection);
-		$curpwd = "ssh2.sftp://$sftp" . $this->pwd;
+		$curpwd = "ssh2.sftp://$sftp".$this->pwd;
 		$dh = @opendir($curpwd);
-		if(!$dh)
+		if (!$dh)
 		{
 			return new Object(-1, 'msg_ftp_invalid_path');
 		}
 		$list = array();
-		while(($file = readdir($dh)) !== FALSE)
+		while (($file = readdir($dh)) !== FALSE)
 		{
-			if(is_dir($curpwd . $file))
+			if (is_dir($curpwd.$file))
 			{
 				$file .= "/";
 			}
@@ -320,32 +320,32 @@ 
 	 */
 	function getAdminFTPList()
 	{
-		Context::loadLang(_XE_PATH_ . 'modules/autoinstall/lang');
+		Context::loadLang(_XE_PATH_.'modules/autoinstall/lang');
 		@set_time_limit(5);
 
-		require_once(_XE_PATH_ . 'libs/ftp.class.php');
+		require_once(_XE_PATH_.'libs/ftp.class.php');
 
 		$ftp_info = Context::getRequestVars();
-		if(!$ftp_info->ftp_user || !$ftp_info->ftp_password)
+		if (!$ftp_info->ftp_user || !$ftp_info->ftp_password)
 		{
 			return new Object(-1, 'msg_ftp_invalid_auth_info');
 		}
 
 		$this->pwd = $ftp_info->ftp_root_path;
 
-		if(!$ftp_info->ftp_host)
+		if (!$ftp_info->ftp_host)
 		{
 			$ftp_info->ftp_host = "127.0.0.1";
 		}
 
-		if(!$ftp_info->ftp_port || !is_numeric($ftp_info->ftp_port))
+		if (!$ftp_info->ftp_port || !is_numeric($ftp_info->ftp_port))
 		{
 			$ftp_info->ftp_port = "21";
 		}
 
-		if($ftp_info->sftp == 'Y')
+		if ($ftp_info->sftp == 'Y')
 		{
-			if(!function_exists('ssh2_sftp'))
+			if (!function_exists('ssh2_sftp'))
 			{
 				return new Object(-1, 'disable_sftp_support');
 			}
@@ -353,9 +353,9 @@ 
 		}
 
 		$oFtp = new ftp();
-		if($oFtp->ftp_connect($ftp_info->ftp_host, $ftp_info->ftp_port))
+		if ($oFtp->ftp_connect($ftp_info->ftp_host, $ftp_info->ftp_port))
 		{
-			if($oFtp->ftp_login($ftp_info->ftp_user, $ftp_info->ftp_password))
+			if ($oFtp->ftp_login($ftp_info->ftp_user, $ftp_info->ftp_password))
 			{
 				$_list = $oFtp->ftp_rawlist($this->pwd);
 				$oFtp->ftp_quit();
@@ -367,17 +367,17 @@ 
 		}
 		$list = array();
 
-		if($_list)
+		if ($_list)
 		{
-			foreach($_list as $k => $v)
+			foreach ($_list as $k => $v)
 			{
 				$src = new stdClass();
 				$src->data = $v;
 				$res = Context::convertEncoding($src);
 				$v = $res->data;
-				if(strpos($v, 'd') === 0 || strpos($v, '<DIR>'))
+				if (strpos($v, 'd') === 0 || strpos($v, '<DIR>'))
 				{
-					$list[] = substr(strrchr($v, ' '), 1) . '/';
+					$list[] = substr(strrchr($v, ' '), 1).'/';
 				}
 			}
 		}
@@ -400,7 +400,7 @@ 
 			, 'module' => array('addon', 'admin', 'autoinstall', 'comment', 'communication', 'counter', 'document', 'editor', 'file', 'importer', 'install', 'integration_search', 'layout', 'member', 'menu', 'message', 'module', 'opage', 'page', 'point', 'poll', 'rss', 'session', 'spamfilter', 'tag', 'trackback', 'trash', 'widget')
 			, 'addon' => array('autolink', 'blogapi', 'captcha', 'counter', 'member_communication', 'member_extra_info', 'mobile', 'openid_delegation_id', 'point_level_icon', 'resize_image')
 			, 'layout' => array('default')
-			, 'widget' => array('content', 'language_select', 'login_info','mcontent')
+			, 'widget' => array('content', 'language_select', 'login_info', 'mcontent')
 			, 'widgetstyle' => array(),
 		);
 		$info = array();
@@ -420,86 +420,86 @@ 
 		$info['use_ssl'] = $db_info->use_ssl;
 		
 		$info['phpext'] = '';
-		foreach(get_loaded_extensions() as $ext)
+		foreach (get_loaded_extensions() as $ext)
 		{
 			$ext = strtolower($ext);
-			if(in_array($ext, $skip['ext']))
+			if (in_array($ext, $skip['ext']))
 			{
 				continue;
 			}
-			$info['phpext'] .= '|' . $ext;
+			$info['phpext'] .= '|'.$ext;
 		}
 		$info['phpext'] = substr($info['phpext'], 1);
 
 		$info['module'] = '';
 		$oModuleModel = getModel('module');
 		$module_list = $oModuleModel->getModuleList();
-		if($module_list) foreach($module_list as $module)
+		if ($module_list) foreach ($module_list as $module)
 		{
-			if(in_array($module->module, $skip['module']))
+			if (in_array($module->module, $skip['module']))
 			{
 				continue;
 			}
-			$info['module'] .= '|' . $module->module;
+			$info['module'] .= '|'.$module->module;
 		}
 		$info['module'] = substr($info['module'], 1);
 
 		$info['addon'] = '';
 		$oAddonAdminModel = getAdminModel('addon');
 		$addon_list = $oAddonAdminModel->getAddonList();
-		if($addon_list) foreach($addon_list as $addon)
+		if ($addon_list) foreach ($addon_list as $addon)
 		{
-			if(in_array($addon->addon, $skip['addon']))
+			if (in_array($addon->addon, $skip['addon']))
 			{
 				continue;
 			}
-			$info['addon'] .= '|' . $addon->addon;
+			$info['addon'] .= '|'.$addon->addon;
 		}
 		$info['addon'] = substr($info['addon'], 1);
 
 		$info['layout'] = "";
 		$oLayoutModel = getModel('layout');
 		$layout_list = $oLayoutModel->getDownloadedLayoutList();
-		if($layout_list) foreach($layout_list as $layout)
+		if ($layout_list) foreach ($layout_list as $layout)
 		{
-			if(in_array($layout->layout, $skip['layout']))
+			if (in_array($layout->layout, $skip['layout']))
 			{
 				continue;
 			}
-			$info['layout'] .= '|' . $layout->layout;
+			$info['layout'] .= '|'.$layout->layout;
 		}
 		$info['layout'] = substr($info['layout'], 1);
 
 		$info['widget'] = "";
 		$oWidgetModel = getModel('widget');
 		$widget_list = $oWidgetModel->getDownloadedWidgetList();
-		if($widget_list) foreach($widget_list as $widget)
+		if ($widget_list) foreach ($widget_list as $widget)
 		{
-			if(in_array($widget->widget, $skip['widget']))
+			if (in_array($widget->widget, $skip['widget']))
 			{
 				continue;
 			}
-			$info['widget'] .= '|' . $widget->widget;
+			$info['widget'] .= '|'.$widget->widget;
 		}
 		$info['widget'] = substr($info['widget'], 1);
 
 		$info['widgetstyle'] = "";
 		$oWidgetModel = getModel('widget');
 		$widgetstyle_list = $oWidgetModel->getDownloadedWidgetStyleList();
-		if($widgetstyle_list) foreach($widgetstyle_list as $widgetstyle)
+		if ($widgetstyle_list) foreach ($widgetstyle_list as $widgetstyle)
 		{
-			if(in_array($widgetstyle->widgetStyle, $skip['widgetstyle']))
+			if (in_array($widgetstyle->widgetStyle, $skip['widgetstyle']))
 			{
 				continue;
 			}
-			$info['widgetstyle'] .= '|' . $widgetstyle->widgetStyle;
+			$info['widgetstyle'] .= '|'.$widgetstyle->widgetStyle;
 		}
 		$info['widgetstyle'] = substr($info['widgetstyle'], 1);
 
 		$param = '';
-		foreach($info as $k => $v)
+		foreach ($info as $k => $v)
 		{
-			if($v)
+			if ($v)
 			{
 				$param .= sprintf('&%s=%s', $k, urlencode($v));
 			}
@@ -515,13 +515,13 @@ 
 	 */
 	function getThemeList()
 	{
-		$path = _XE_PATH_ . 'themes';
+		$path = _XE_PATH_.'themes';
 		$list = FileHandler::readDir($path);
 
 		$theme_info = array();
-		if(count($list) > 0)
+		if (count($list) > 0)
 		{
-			foreach($list as $val)
+			foreach ($list as $val)
 			{
 				$theme_info[$val] = $this->getThemeInfo($val);
 			}
@@ -538,20 +538,20 @@ 
 	 */
 	function getThemeInfo($theme_name, $layout_list = NULL)
 	{
-		if($GLOBALS['__ThemeInfo__'][$theme_name])
+		if ($GLOBALS['__ThemeInfo__'][$theme_name])
 		{
 			return $GLOBALS['__ThemeInfo__'][$theme_name];
 		}
 
-		$info_file = _XE_PATH_ . 'themes/' . $theme_name . '/conf/info.xml';
-		if(!file_exists($info_file))
+		$info_file = _XE_PATH_.'themes/'.$theme_name.'/conf/info.xml';
+		if (!file_exists($info_file))
 		{
 			return;
 		}
 
 		$oXmlParser = new XmlParser();
 		$_xml_obj = $oXmlParser->loadXmlFile($info_file);
-		if(!$_xml_obj->theme)
+		if (!$_xml_obj->theme)
 		{
 			return;
 		}
@@ -562,16 +562,16 @@ 
 		$theme_info = new stdClass();
 		$theme_info->name = $theme_name;
 		$theme_info->title = $xml_obj->title->body;
-		$thumbnail = './themes/' . $theme_name . '/thumbnail.png';
+		$thumbnail = './themes/'.$theme_name.'/thumbnail.png';
 		$theme_info->thumbnail = (FileHandler::exists($thumbnail)) ? $thumbnail : NULL;
 		$theme_info->version = $xml_obj->version->body;
 		$date_obj = new stdClass();
 		sscanf($xml_obj->date->body, '%d-%d-%d', $date_obj->y, $date_obj->m, $date_obj->d);
 		$theme_info->date = sprintf('%04d%02d%02d', $date_obj->y, $date_obj->m, $date_obj->d);
 		$theme_info->description = $xml_obj->description->body;
-		$theme_info->path = './themes/' . $theme_name . '/';
+		$theme_info->path = './themes/'.$theme_name.'/';
 
-		if(!is_array($xml_obj->publisher))
+		if (!is_array($xml_obj->publisher))
 		{
 			$publisher_list = array();
 			$publisher_list[] = $xml_obj->publisher;
@@ -582,7 +582,7 @@ 
 		}
 
 		$theme_info->publisher = array();
-		foreach($publisher_list as $publisher)
+		foreach ($publisher_list as $publisher)
 		{
 			$publisher_obj = new stdClass();
 			$publisher_obj->name = $publisher->name->body;
@@ -595,10 +595,10 @@ 
 		$layout_path = $layout->directory->attrs->path;
 		$layout_parse = explode('/', $layout_path);
 		$layout_info = new stdClass();
-		switch($layout_parse[1])
+		switch ($layout_parse[1])
 		{
 			case 'themes' :
-					$layout_info->name = $theme_name . '|@|' . $layout_parse[count($layout_parse) - 1];
+					$layout_info->name = $theme_name.'|@|'.$layout_parse[count($layout_parse) - 1];
 					break;
 
 			case 'layouts' :
@@ -615,11 +615,11 @@ 
 		$oLayoutModel = getModel('layout');
 		$layout_info_list = array();
 		$layout_list = $oLayoutModel->getLayoutList($site_info->site_srl);
-		if($layout_list)
+		if ($layout_list)
 		{
-			foreach($layout_list as $val)
+			foreach ($layout_list as $val)
 			{
-				if($val->layout == $layout_info->name)
+				if ($val->layout == $layout_info->name)
 				{
 					$is_new_layout = FALSE;
 					$layout_info->layout_srl = $val->layout_srl;
@@ -628,7 +628,7 @@ 
 			}
 		}
 
-		if($is_new_layout)
+		if ($is_new_layout)
 		{
 			$site_module_info = Context::get('site_module_info');
 			$args = new stdClass();
@@ -646,7 +646,7 @@ 
 		$theme_info->layout_info = $layout_info;
 
 		$skin_infos = $xml_obj->skininfos;
-		if(is_array($skin_infos->skininfo))
+		if (is_array($skin_infos->skininfo))
 		{
 			$skin_list = $skin_infos->skininfo;
 		}
@@ -657,17 +657,17 @@ 
 
 		$oModuleModel = getModel('module');
 		$skins = array();
-		foreach($skin_list as $val)
+		foreach ($skin_list as $val)
 		{
 			$skin_info = new stdClass();
 			unset($skin_parse);
 			$skin_parse = explode('/', $val->directory->attrs->path);
-			switch($skin_parse[1])
+			switch ($skin_parse[1])
 			{
 				case 'themes' :
 						$is_theme = TRUE;
 						$module_name = $skin_parse[count($skin_parse) - 1];
-						$skin_info->name = $theme_name . '|@|' . $module_name;
+						$skin_info->name = $theme_name.'|@|'.$module_name;
 						break;
 
 				case 'modules' :
@@ -681,9 +681,9 @@ 
 			$skin_info->is_theme = $is_theme;
 			$skins[$module_name] = $skin_info;
 
-			if($is_theme)
+			if ($is_theme)
 			{
-				if(!$GLOBALS['__ThemeModuleSkin__'][$module_name])
+				if (!$GLOBALS['__ThemeModuleSkin__'][$module_name])
 				{
 					$GLOBALS['__ThemeModuleSkin__'][$module_name] = array();
 					$GLOBALS['__ThemeModuleSkin__'][$module_name]['skins'] = array();
@@ -705,7 +705,7 @@ 
 	 */
 	function getModulesSkinList()
 	{
-		if($GLOBALS['__ThemeModuleSkin__']['__IS_PARSE__'])
+		if ($GLOBALS['__ThemeModuleSkin__']['__IS_PARSE__'])
 		{
 			return $GLOBALS['__ThemeModuleSkin__'];
 		}
@@ -713,7 +713,7 @@ 
 		sort($searched_list);
 
 		$searched_count = count($searched_list);
-		if(!$searched_count)
+		if (!$searched_count)
 		{
 			return;
 		}
@@ -721,13 +721,13 @@ 
 		$exceptionModule = array('editor', 'poll', 'homepage', 'textyle');
 
 		$oModuleModel = getModel('module');
-		foreach($searched_list as $val)
+		foreach ($searched_list as $val)
 		{
-			$skin_list = $oModuleModel->getSkins(_XE_PATH_ . 'modules/' . $val);
+			$skin_list = $oModuleModel->getSkins(_XE_PATH_.'modules/'.$val);
 
-			if(is_array($skin_list) && count($skin_list) > 0 && !in_array($val, $exceptionModule))
+			if (is_array($skin_list) && count($skin_list) > 0 && !in_array($val, $exceptionModule))
 			{
-				if(!$GLOBALS['__ThemeModuleSkin__'][$val])
+				if (!$GLOBALS['__ThemeModuleSkin__'][$val])
 				{
 					$GLOBALS['__ThemeModuleSkin__'][$val] = array();
 					$moduleInfo = $oModuleModel->getModuleInfoXml($val);
@@ -752,22 +752,22 @@ 
 		$cacheFile = sprintf('./files/cache/menu/admin_lang/adminMenu.%s.lang.php', $currentLang);
 
 		// Update if no cache file exists or it is older than xml file
-		if(!is_readable($cacheFile))
+		if (!is_readable($cacheFile))
 		{
 			$lang = new stdClass();
 			$oModuleModel = getModel('module');
 			$installed_module_list = $oModuleModel->getModulesXmlInfo();
 
 			$this->gnbLangBuffer = '<?php $lang = new stdClass();';
-			foreach($installed_module_list AS $key => $value)
+			foreach ($installed_module_list AS $key => $value)
 			{
 				$moduleActionInfo = $oModuleModel->getModuleActionXml($value->module);
-				if(is_object($moduleActionInfo->menu))
+				if (is_object($moduleActionInfo->menu))
 				{
-					foreach($moduleActionInfo->menu AS $key2 => $value2)
+					foreach ($moduleActionInfo->menu AS $key2 => $value2)
 					{
 						$lang->menu_gnb_sub[$key2] = $value2->title;
-						$this->gnbLangBuffer .=sprintf('$lang->menu_gnb_sub[\'%s\'] = \'%s\';', $key2, $value2->title);
+						$this->gnbLangBuffer .= sprintf('$lang->menu_gnb_sub[\'%s\'] = \'%s\';', $key2, $value2->title);
 					}
 				}
 			}
@@ -793,19 +793,19 @@ 
 		$args = new stdClass();
 		$args->site_srl = $siteSrl;
 		$output = executeQueryArray('admin.getFavoriteList', $args);
-		if(!$output->toBool())
+		if (!$output->toBool())
 		{
 			return $output;
 		}
-		if(!$output->data)
+		if (!$output->data)
 		{
 			return new Object();
 		}
 
-		if($isGetModuleInfo && is_array($output->data))
+		if ($isGetModuleInfo && is_array($output->data))
 		{
 			$oModuleModel = getModel('module');
-			foreach($output->data AS $key => $value)
+			foreach ($output->data AS $key => $value)
 			{
 				$moduleInfo = $oModuleModel->getModuleInfoXml($value->module);
 				$output->data[$key]->admin_index_act = $moduleInfo->admin_index_act;
@@ -830,13 +830,13 @@ 
 		$args->site_srl = $siteSrl;
 		$args->module = $module;
 		$output = executeQuery('admin.getFavorite', $args);
-		if(!$output->toBool())
+		if (!$output->toBool())
 		{
 			return $output;
 		}
 
 		$returnObject = new Object();
-		if($output->data)
+		if ($output->data)
 		{
 			$returnObject->add('result', TRUE);
 			$returnObject->add('favoriteSrl', $output->data->admin_favorite_srl);
@@ -855,7 +855,7 @@ 
 	 */
 	function getSiteAllList()
 	{
-		if(Context::get('domain'))
+		if (Context::get('domain'))
 		{
 			$domain = Context::get('domain');
 		}
@@ -872,7 +872,7 @@ 
 	function getAllSitesThatHaveModules($domain = NULL)
 	{
 		$args = new stdClass();
-		if($domain)
+		if ($domain)
 		{
 			$args->domain = $domain;
 		}
@@ -880,31 +880,31 @@ 
 
 		$siteList = array();
 		$output = executeQueryArray('admin.getSiteAllList', $args, $columnList);
-		if($output->toBool())
+		if ($output->toBool())
 		{
 			$siteList = $output->data;
 		}
 
 		$oModuleModel = getModel('module');
-		foreach($siteList as $key => $value)
+		foreach ($siteList as $key => $value)
 		{
 			$args->site_srl = $value->site_srl;
 			$list = $oModuleModel->getModuleSrlList($args);
 
-			if(!is_array($list))
+			if (!is_array($list))
 			{
 				$list = array($list);
 			}
 
-			foreach($list as $k => $v)
+			foreach ($list as $k => $v)
 			{
-				if(!is_dir(_XE_PATH_ . 'modules/' . $v->module))
+				if (!is_dir(_XE_PATH_.'modules/'.$v->module))
 				{
 					unset($list[$k]);
 				}
 			}
 
-			if(!count($list))
+			if (!count($list))
 			{
 				unset($siteList[$key]);
 			}
@@ -921,13 +921,13 @@ 
 	{
 		$args = new stdClass();
 
-		if($date)
+		if ($date)
 		{
 			$args->regDate = date('Ymd', strtotime($date));
 		}
 
 		$output = executeQuery('admin.getSiteCountByDate', $args);
-		if(!$output->toBool())
+		if (!$output->toBool())
 		{
 			return 0;
 		}
@@ -949,21 +949,21 @@ 
 	{
 		$site_info = Context::get('site_module_info');
 		$virtual_site = '';
-		if($site_info->site_srl) 
+		if ($site_info->site_srl) 
 		{
-			$virtual_site = $site_info->site_srl . '/';
+			$virtual_site = $site_info->site_srl.'/';
 		}
 
-		$file_exsit = FileHandler::readFile(_XE_PATH_ . 'files/attach/xeicon/' . $virtual_site . $iconname);
-		if(!$file_exsit && $default === true)
+		$file_exsit = FileHandler::readFile(_XE_PATH_.'files/attach/xeicon/'.$virtual_site.$iconname);
+		if (!$file_exsit && $default === true)
         {
-            $icon_url = './modules/admin/tpl/img/' . $default_icon_name;
+            $icon_url = './modules/admin/tpl/img/'.$default_icon_name;
         }
-        elseif($file_exsit)
+        elseif ($file_exsit)
 		{
 			$default_url = Context::getDefaultUrl();
-			if($default_url && substr_compare($default_url, '/', -1) === 0) $default_url = substr($default_url, 0, -1);
-			$icon_url = $default_url . '/files/attach/xeicon/' . $virtual_site . $iconname;
+			if ($default_url && substr_compare($default_url, '/', -1) === 0) $default_url = substr($default_url, 0, -1);
+			$icon_url = $default_url.'/files/attach/xeicon/'.$virtual_site.$iconname;
 		}
 		return $icon_url;
 	}

Braces +26 added lines, -22 removed lines

@@ -303,8 +303,7 @@ 
 			if(is_dir($curpwd . $file))
 			{
 				$file .= "/";
-			}
-			else
+			} else
 			{
 				continue;
 			}
@@ -359,8 +358,7 @@ 
 			{
 				$_list = $oFtp->ftp_rawlist($this->pwd);
 				$oFtp->ftp_quit();
-			}
-			else
+			} else
 			{
 				return new Object(-1, 'msg_ftp_invalid_auth_info');
 			}
@@ -380,8 +378,7 @@ 
 					$list[] = substr(strrchr($v, ' '), 1) . '/';
 				}
 			}
-		}
-		else
+		} else
 		{
 			return new Object(-1, 'msg_ftp_no_directory');
 		}
@@ -434,11 +431,13 @@ 
 		$info['module'] = '';
 		$oModuleModel = getModel('module');
 		$module_list = $oModuleModel->getModuleList();
-		if($module_list) foreach($module_list as $module)
+		if($module_list) {
+			foreach($module_list as $module)
 		{
 			if(in_array($module->module, $skip['module']))
 			{
 				continue;
+		}
 			}
 			$info['module'] .= '|' . $module->module;
 		}
@@ -447,11 +446,13 @@ 
 		$info['addon'] = '';
 		$oAddonAdminModel = getAdminModel('addon');
 		$addon_list = $oAddonAdminModel->getAddonList();
-		if($addon_list) foreach($addon_list as $addon)
+		if($addon_list) {
+			foreach($addon_list as $addon)
 		{
 			if(in_array($addon->addon, $skip['addon']))
 			{
 				continue;
+		}
 			}
 			$info['addon'] .= '|' . $addon->addon;
 		}
@@ -460,11 +461,13 @@ 
 		$info['layout'] = "";
 		$oLayoutModel = getModel('layout');
 		$layout_list = $oLayoutModel->getDownloadedLayoutList();
-		if($layout_list) foreach($layout_list as $layout)
+		if($layout_list) {
+			foreach($layout_list as $layout)
 		{
 			if(in_array($layout->layout, $skip['layout']))
 			{
 				continue;
+		}
 			}
 			$info['layout'] .= '|' . $layout->layout;
 		}
@@ -473,11 +476,13 @@ 
 		$info['widget'] = "";
 		$oWidgetModel = getModel('widget');
 		$widget_list = $oWidgetModel->getDownloadedWidgetList();
-		if($widget_list) foreach($widget_list as $widget)
+		if($widget_list) {
+			foreach($widget_list as $widget)
 		{
 			if(in_array($widget->widget, $skip['widget']))
 			{
 				continue;
+		}
 			}
 			$info['widget'] .= '|' . $widget->widget;
 		}
@@ -486,11 +491,13 @@ 
 		$info['widgetstyle'] = "";
 		$oWidgetModel = getModel('widget');
 		$widgetstyle_list = $oWidgetModel->getDownloadedWidgetStyleList();
-		if($widgetstyle_list) foreach($widgetstyle_list as $widgetstyle)
+		if($widgetstyle_list) {
+			foreach($widgetstyle_list as $widgetstyle)
 		{
 			if(in_array($widgetstyle->widgetStyle, $skip['widgetstyle']))
 			{
 				continue;
+		}
 			}
 			$info['widgetstyle'] .= '|' . $widgetstyle->widgetStyle;
 		}
@@ -575,8 +582,7 @@ 
 		{
 			$publisher_list = array();
 			$publisher_list[] = $xml_obj->publisher;
-		}
-		else
+		} else
 		{
 			$publisher_list = $xml_obj->publisher;
 		}
@@ -649,8 +655,7 @@ 
 		if(is_array($skin_infos->skininfo))
 		{
 			$skin_list = $skin_infos->skininfo;
-		}
-		else
+		} else
 		{
 			$skin_list = array($skin_infos->skininfo);
 		}
@@ -773,8 +778,7 @@ 
 			}
 			$this->gnbLangBuffer .= ' ?>';
 			FileHandler::writeFile($cacheFile, $this->gnbLangBuffer);
-		}
-		else
+		} else
 		{
 			include $cacheFile;
 		}
@@ -840,8 +844,7 @@ 
 		{
 			$returnObject->add('result', TRUE);
 			$returnObject->add('favoriteSrl', $output->data->admin_favorite_srl);
-		}
-		else
+		} else
 		{
 			$returnObject->add('result', FALSE);
 		}
@@ -958,11 +961,12 @@ 
 		if(!$file_exsit && $default === true)
         {
             $icon_url = './modules/admin/tpl/img/' . $default_icon_name;
-        }
-        elseif($file_exsit)
+        } elseif($file_exsit)
 		{
 			$default_url = Context::getDefaultUrl();
-			if($default_url && substr_compare($default_url, '/', -1) === 0) $default_url = substr($default_url, 0, -1);
+			if($default_url && substr_compare($default_url, '/', -1) === 0) {
+				$default_url = substr($default_url, 0, -1);
+			}
 			$icon_url = $default_url . '/files/attach/xeicon/' . $virtual_site . $iconname;
 		}
 		return $icon_url;

modules/admin/admin.admin.view.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
 
 	/**
 	 * Initilization
-	 * @return void
+	 * @return ModuleObject|null
 	 */
 	function init()
 	{

Indentation +1 added lines, -1 removed lines

@@ -566,7 +566,7 @@
 	/**
 	 * Retrun server environment to XML string
 	 * @return object
-	*/
+	 */
 	function dispAdminViewServerEnv()
 	{
 		$info = array();

Spacing +77 added lines, -77 removed lines

@@ -28,7 +28,7 @@ 
 	{
 		$db_info = Context::getDBInfo();
 
-		if(strpos($db_info->default_url, 'xn--') !== FALSE)
+		if (strpos($db_info->default_url, 'xn--') !== FALSE)
 		{
 			$xe_default_url = Context::decodeIdna($db_info->default_url);
 		}
@@ -48,13 +48,13 @@ 
 		// forbit access if the user is not an administrator
 		$oMemberModel = getModel('member');
 		$logged_info = $oMemberModel->getLoggedInfo();
-		if($logged_info->is_admin != 'Y')
+		if ($logged_info->is_admin != 'Y')
 		{
 			return $this->stop("msg_is_not_administrator");
 		}
 
 		// change into administration layout
-		$this->setTemplatePath($this->module_path . 'tpl');
+		$this->setTemplatePath($this->module_path.'tpl');
 		$this->setLayoutPath($this->getTemplatePath());
 		$this->setLayoutFile('layout.html');
 
@@ -74,11 +74,11 @@ 
 		Context::set('use_db_session', $db_info->use_db_session == 'N' ? 'N' : 'Y');
 		Context::set('use_mobile_view', $db_info->use_mobile_view == 'Y' ? 'Y' : 'N');
 		Context::set('use_ssl', $db_info->use_ssl ? $db_info->use_ssl : "none");
-		if($db_info->http_port)
+		if ($db_info->http_port)
 		{
 			Context::set('http_port', $db_info->http_port);
 		}
-		if($db_info->https_port)
+		if ($db_info->https_port)
 		{
 			Context::set('https_port', $db_info->https_port);
 		}
@@ -94,7 +94,7 @@ 
 	function checkEasyinstall()
 	{
 		$lastTime = (int) FileHandler::readFile($this->easyinstallCheckFile);
-		if($lastTime > $_SERVER['REQUEST_TIME'] - 60 * 60 * 24 * 30)
+		if ($lastTime > $_SERVER['REQUEST_TIME'] - 60 * 60 * 24 * 30)
 		{
 			return;
 		}
@@ -108,14 +108,14 @@ 
 		$lUpdateDoc = $xml_lUpdate->parse($buff);
 		$updateDate = $lUpdateDoc->response->updatedate->body;
 
-		if(!$updateDate)
+		if (!$updateDate)
 		{
 			$this->_markingCheckEasyinstall();
 			return;
 		}
 
 		$item = $oAutoinstallModel->getLatestPackage();
-		if(!$item || $item->updatedate < $updateDate)
+		if (!$item || $item->updatedate < $updateDate)
 		{
 			$oController = getAdminController('autoinstall');
 			$oController->_updateinfo();
@@ -144,7 +144,7 @@ 
 
 		// Check is_shortcut column
 		$oDB = DB::getInstance();
-		if(!$oDB->isColumnExists('menu_item', 'is_shortcut'))
+		if (!$oDB->isColumnExists('menu_item', 'is_shortcut'))
 		{
 			return;
 		}
@@ -162,9 +162,9 @@ 
 		$currentAct = Context::get('act');
 		$subMenuTitle = '';
 
-		foreach((array) $moduleActionInfo->menu as $key => $value)
+		foreach ((array) $moduleActionInfo->menu as $key => $value)
 		{
-			if(isset($value->acts) && is_array($value->acts) && in_array($currentAct, $value->acts))
+			if (isset($value->acts) && is_array($value->acts) && in_array($currentAct, $value->acts))
 			{
 				$subMenuTitle = $value->title;
 				break;
@@ -173,21 +173,21 @@ 
 		// get current menu's srl(=parentSrl)
 		$parentSrl = 0;
 		$oMenuAdminConroller = getAdminController('menu');
-		foreach((array) $menu->list as $parentKey => $parentMenu)
+		foreach ((array) $menu->list as $parentKey => $parentMenu)
 		{
-			if(!is_array($parentMenu['list']) || !count($parentMenu['list']))
+			if (!is_array($parentMenu['list']) || !count($parentMenu['list']))
 			{
 				continue;
 			}
-			if($parentMenu['href'] == '#' && count($parentMenu['list']))
+			if ($parentMenu['href'] == '#' && count($parentMenu['list']))
 			{
 				$firstChild = current($parentMenu['list']);
 				$menu->list[$parentKey]['href'] = $firstChild['href'];
 			}
 
-			foreach($parentMenu['list'] as $childKey => $childMenu)
+			foreach ($parentMenu['list'] as $childKey => $childMenu)
 			{
-				if($subMenuTitle == $childMenu['text'] && $parentSrl == 0)
+				if ($subMenuTitle == $childMenu['text'] && $parentSrl == 0)
 				{
 					$parentSrl = $childMenu['parent_srl'];
 				}
@@ -200,7 +200,7 @@ 
 		$gnbTitleInfo->adminTitle = $objConfig->adminTitle ? $objConfig->adminTitle : 'XE Admin';
 		$gnbTitleInfo->adminLogo = $objConfig->adminLogo ? $objConfig->adminLogo : 'modules/admin/tpl/img/xe.h1.png';
 
-		$browserTitle = ($subMenuTitle ? $subMenuTitle : 'Dashboard') . ' - ' . $gnbTitleInfo->adminTitle;
+		$browserTitle = ($subMenuTitle ? $subMenuTitle : 'Dashboard').' - '.$gnbTitleInfo->adminTitle;
 
 		// Get list of favorite
 		$oAdminAdminModel = getAdminModel('admin');
@@ -211,7 +211,7 @@ 
 		// move from index method, because use in admin footer
 		$newest_news_url = sprintf("http://news.xpressengine.com/%s/news.php?version=%s&package=%s", _XE_LOCATION_, __XE_VERSION__, _XE_PACKAGE_);
 		$cache_file = sprintf("%sfiles/cache/newest_news.%s.cache.php", _XE_PATH_, _XE_LOCATION_);
-		if(!file_exists($cache_file) || filemtime($cache_file) + 60 * 60 < $_SERVER['REQUEST_TIME'])
+		if (!file_exists($cache_file) || filemtime($cache_file) + 60 * 60 < $_SERVER['REQUEST_TIME'])
 		{
 			// Considering if data cannot be retrieved due to network problem, modify filemtime to prevent trying to reload again when refreshing administration page
 			// Ensure to access the administration page even though news cannot be displayed
@@ -219,20 +219,20 @@ 
 			FileHandler::getRemoteFile($newest_news_url, $cache_file, null, 1, 'GET', 'text/html', array('REQUESTURL' => getFullUrl('')));
 		}
 
-		if(file_exists($cache_file))
+		if (file_exists($cache_file))
 		{
 			$oXml = new XmlParser();
 			$buff = $oXml->parse(FileHandler::readFile($cache_file));
 
 			$item = $buff->zbxe_news->item;
-			if($item)
+			if ($item)
 			{
-				if(!is_array($item))
+				if (!is_array($item))
 				{
 					$item = array($item);
 				}
 
-				foreach($item as $key => $val)
+				foreach ($item as $key => $val)
 				{
 					$obj = new stdClass();
 					$obj->title = $val->body;
@@ -241,7 +241,7 @@ 
 					$news[] = $obj;
 				}
 				Context::set('news', $news);
-				if(isset($news) && is_array($news))
+				if (isset($news) && is_array($news))
 				{
 					Context::set('latestVersion', array_shift($news));
 				}
@@ -264,7 +264,7 @@ 
 	function dispAdminIndex()
 	{
 		$db_info = Context::getDBInfo();
-		Context::set('db_info',$db_info);
+		Context::set('db_info', $db_info);
 
 		// Get statistics
 		$args = new stdClass();
@@ -301,9 +301,9 @@ 
 		$args = new stdClass();
 		$args->list_count = 5;
 		$output = $oCommentModel->getNewestCommentList($args, $columnList);
-		if(is_array($output))
+		if (is_array($output))
 		{
-			foreach($output AS $key => $value)
+			foreach ($output AS $key => $value)
 			{
 				$value->content = strip_tags($value->content);
 			}
@@ -314,17 +314,17 @@ 
 		// Get list of modules
 		$oModuleModel = getModel('module');
 		$module_list = $oModuleModel->getModuleList();
-		if(is_array($module_list))
+		if (is_array($module_list))
 		{
 			$needUpdate = FALSE;
 			$addTables = FALSE;
-			foreach($module_list AS $key => $value)
+			foreach ($module_list AS $key => $value)
 			{
-				if($value->need_install)
+				if ($value->need_install)
 				{
 					$addTables = TRUE;
 				}
-				if($value->need_update)
+				if ($value->need_update)
 				{
 					$needUpdate = TRUE;
 				}
@@ -335,12 +335,12 @@ 
 		$oAutoinstallAdminModel = getAdminModel('autoinstall');
 		$needUpdateList = $oAutoinstallAdminModel->getNeedUpdateList();
 
-		if(is_array($needUpdateList))
+		if (is_array($needUpdateList))
 		{
-			foreach($needUpdateList AS $key => $value)
+			foreach ($needUpdateList AS $key => $value)
 			{
 				$helpUrl = './admin/help/index.html#';
-				switch($value->type)
+				switch ($value->type)
 				{
 					case 'addon':
 						$helpUrl .= 'UMAN_terminology_addon';
@@ -367,8 +367,8 @@ 
 
 		$site_module_info = Context::get('site_module_info');
 		$oAddonAdminModel = getAdminModel('addon');
-		$counterAddonActivated = $oAddonAdminModel->isActivatedAddon('counter', $site_module_info->site_srl );
-		if(!$counterAddonActivated)
+		$counterAddonActivated = $oAddonAdminModel->isActivatedAddon('counter', $site_module_info->site_srl);
+		if (!$counterAddonActivated)
 		{
 			$columnList = array('member_srl', 'nick_name', 'user_name', 'user_id', 'email_address');
 			$args = new stdClass;
@@ -391,9 +391,9 @@ 
 
 		// gathering enviroment check
 		$mainVersion = join('.', array_slice(explode('.', __XE_VERSION__), 0, 2));
-		$path = FileHandler::getRealPath('./files/env/' . $mainVersion);
+		$path = FileHandler::getRealPath('./files/env/'.$mainVersion);
 		$isEnviromentGatheringAgreement = FALSE;
-		if(file_exists($path))
+		if (file_exists($path))
 		{
 			$isEnviromentGatheringAgreement = TRUE;
 		}
@@ -403,7 +403,7 @@ 
 		$isLicenseAgreement = FALSE;
 		$path = FileHandler::getRealPath('./files/env/license_agreement');
 		$isLicenseAgreement = FALSE;
-		if(file_exists($path))
+		if (file_exists($path))
 		{
 			$isLicenseAgreement = TRUE;
 		}
@@ -425,7 +425,7 @@ 
 
 		Context::set('selected_lang', $db_info->lang_type);
 
-		if(strpos($db_info->default_url, 'xn--') !== FALSE)
+		if (strpos($db_info->default_url, 'xn--') !== FALSE)
 		{
 			$db_info->default_url = Context::decodeIdna($db_info->default_url);
 		}
@@ -434,9 +434,9 @@ 
 
 		// site lock
 		Context::set('IP', $_SERVER['REMOTE_ADDR']);
-		if(!$db_info->sitelock_title) $db_info->sitelock_title = 'Maintenance in progress...';
-		if(!in_array('127.0.0.1', $db_info->sitelock_whitelist)) $db_info->sitelock_whitelist[] = '127.0.0.1';
-		if(!in_array($_SERVER['REMOTE_ADDR'], $db_info->sitelock_whitelist)) $db_info->sitelock_whitelist[] = $_SERVER['REMOTE_ADDR'];
+		if (!$db_info->sitelock_title) $db_info->sitelock_title = 'Maintenance in progress...';
+		if (!in_array('127.0.0.1', $db_info->sitelock_whitelist)) $db_info->sitelock_whitelist[] = '127.0.0.1';
+		if (!in_array($_SERVER['REMOTE_ADDR'], $db_info->sitelock_whitelist)) $db_info->sitelock_whitelist[] = $_SERVER['REMOTE_ADDR'];
 		$db_info->sitelock_whitelist = array_unique($db_info->sitelock_whitelist);
 		Context::set('remote_addr', $_SERVER['REMOTE_ADDR']);
 		Context::set('use_sitelock', $db_info->use_sitelock);
@@ -447,7 +447,7 @@ 
 		Context::set('sitelock_whitelist', $whitelist);
 
 
-		if($db_info->admin_ip_list) $admin_ip_list = implode("\r\n", $db_info->admin_ip_list);
+		if ($db_info->admin_ip_list) $admin_ip_list = implode("\r\n", $db_info->admin_ip_list);
 		else $admin_ip_list = '';
 		Context::set('admin_ip_list', $admin_ip_list);
 
@@ -470,7 +470,7 @@ 
 		Context::set('htmlFooter', htmlspecialchars($config->htmlFooter));
 
 		// embed filter
-		require_once(_XE_PATH_ . 'classes/security/EmbedFilter.class.php');
+		require_once(_XE_PATH_.'classes/security/EmbedFilter.class.php');
 		$oEmbedFilter = EmbedFilter::getInstance();
 		context::set('embed_white_object', implode(PHP_EOL, $oEmbedFilter->whiteUrlList));
 		context::set('embed_white_iframe', implode(PHP_EOL, $oEmbedFilter->whiteIframeUrlList));
@@ -529,36 +529,36 @@ 
 	 */
 	function showSendEnv()
 	{
-		if(Context::getResponseMethod() != 'HTML')
+		if (Context::getResponseMethod() != 'HTML')
 		{
 			return;
 		}
 
 		$server = 'http://collect.xpressengine.com/env/img.php?';
 		$path = './files/env/';
-		$install_env = $path . 'install';
+		$install_env = $path.'install';
 		$mainVersion = join('.', array_slice(explode('.', __XE_VERSION__), 0, 2));
 
-		if(file_exists(FileHandler::getRealPath($install_env)))
+		if (file_exists(FileHandler::getRealPath($install_env)))
 		{
 			$oAdminAdminModel = getAdminModel('admin');
 			$params = $oAdminAdminModel->getEnv('INSTALL');
-			$img = sprintf('<img src="%s" alt="" style="height:0px;width:0px" />', $server . $params);
+			$img = sprintf('<img src="%s" alt="" style="height:0px;width:0px" />', $server.$params);
 			Context::addHtmlFooter($img);
 
-			FileHandler::writeFile($path . $mainVersion, '1');
+			FileHandler::writeFile($path.$mainVersion, '1');
 		}
-		else if(isset($_SESSION['enviroment_gather']) && !file_exists(FileHandler::getRealPath($path . $mainVersion)))
+		else if (isset($_SESSION['enviroment_gather']) && !file_exists(FileHandler::getRealPath($path.$mainVersion)))
 		{
-			if($_SESSION['enviroment_gather'] == 'Y')
+			if ($_SESSION['enviroment_gather'] == 'Y')
 			{
 				$oAdminAdminModel = getAdminModel('admin');
 				$params = $oAdminAdminModel->getEnv();
-				$img = sprintf('<img src="%s" alt="" style="height:0px;width:0px" />', $server . $params);
+				$img = sprintf('<img src="%s" alt="" style="height:0px;width:0px" />', $server.$params);
 				Context::addHtmlFooter($img);
 			}
 
-			FileHandler::writeFile($path . $mainVersion, '1');
+			FileHandler::writeFile($path.$mainVersion, '1');
 			unset($_SESSION['enviroment_gather']);
 		}
 	}
@@ -576,64 +576,64 @@ 
 		$tmp = explode("&", $envInfo);
 		$arrInfo = array();
 		$xe_check_env = array();
-		foreach($tmp as $value) {
+		foreach ($tmp as $value) {
 			$arr = explode("=", $value);
-			if($arr[0]=="type") {
+			if ($arr[0] == "type") {
 				continue;
-			}elseif($arr[0]=="phpext" ) {
+			}elseif ($arr[0] == "phpext") {
 				$str = urldecode($arr[1]);
-				$xe_check_env[$arr[0]]= str_replace("|", ", ", $str);
-			} elseif($arr[0]=="module" ) {
+				$xe_check_env[$arr[0]] = str_replace("|", ", ", $str);
+			} elseif ($arr[0] == "module") {
 				$str = urldecode($arr[1]);
 				$arrModuleName = explode("|", $str);
 				$oModuleModel = getModel("module");
 				$mInfo = array();
-				foreach($arrModuleName as $moduleName) {
+				foreach ($arrModuleName as $moduleName) {
 					$moduleInfo = $oModuleModel->getModuleInfoXml($moduleName);
 					$mInfo[] = "{$moduleName}({$moduleInfo->version})";
 				}
-				$xe_check_env[$arr[0]]= join(", ", $mInfo);
-			} elseif($arr[0]=="addon") {
+				$xe_check_env[$arr[0]] = join(", ", $mInfo);
+			} elseif ($arr[0] == "addon") {
 				$str = urldecode($arr[1]);
 				$arrAddonName = explode("|", $str);
 				$oAddonModel = getAdminModel("addon");
 				$mInfo = array();
-				foreach($arrAddonName as $addonName) {
+				foreach ($arrAddonName as $addonName) {
 					$addonInfo = $oAddonModel->getAddonInfoXml($addonName);
 					$mInfo[] = "{$addonName}({$addonInfo->version})";
 				}
-				$xe_check_env[$arr[0]]= join(", ", $mInfo);
-			} elseif($arr[0]=="widget") {
+				$xe_check_env[$arr[0]] = join(", ", $mInfo);
+			} elseif ($arr[0] == "widget") {
 				$str = urldecode($arr[1]);
 				$arrWidgetName = explode("|", $str);
 				$oWidgetModel = getModel("widget");
 				$mInfo = array();
-				foreach($arrWidgetName as $widgetName) {
+				foreach ($arrWidgetName as $widgetName) {
 					$widgetInfo = $oWidgetModel->getWidgetInfo($widgetName);
 					$mInfo[] = "{$widgetName}({$widgetInfo->version})";
 				}
-				$xe_check_env[$arr[0]]= join(", ", $mInfo);
-			} elseif($arr[0]=="widgetstyle") {
+				$xe_check_env[$arr[0]] = join(", ", $mInfo);
+			} elseif ($arr[0] == "widgetstyle") {
 				$str = urldecode($arr[1]);
 				$arrWidgetstyleName = explode("|", $str);
 				$oWidgetModel = getModel("widget");
 				$mInfo = array();
-				foreach($arrWidgetstyleName as $widgetstyleName) {
+				foreach ($arrWidgetstyleName as $widgetstyleName) {
 					$widgetstyleInfo = $oWidgetModel->getWidgetStyleInfo($widgetstyleName);
 					$mInfo[] = "{$widgetstyleName}({$widgetstyleInfo->version})";
 				}
-				$xe_check_env[$arr[0]]= join(", ", $mInfo);
+				$xe_check_env[$arr[0]] = join(", ", $mInfo);
 
-			} elseif($arr[0]=="layout") {
+			} elseif ($arr[0] == "layout") {
 				$str = urldecode($arr[1]);
 				$arrLayoutName = explode("|", $str);
 				$oLayoutModel = getModel("layout");
 				$mInfo = array();
-				foreach($arrLayoutName as $layoutName) {
+				foreach ($arrLayoutName as $layoutName) {
 					$layoutInfo = $oLayoutModel->getLayoutInfo($layoutName);
 					$mInfo[] = "{$layoutName}({$layoutInfo->version})";
 				}
-				$xe_check_env[$arr[0]]= join(", ", $mInfo);
+				$xe_check_env[$arr[0]] = join(", ", $mInfo);
 			} else {
 				$xe_check_env[$arr[0]] = urldecode($arr[1]);
 			}
@@ -647,15 +647,15 @@ 
 		$php_core['memory_limit'] = "{$ini_info['memory_limit']['local_value']}";
 		$info['PHP_Core'] = $php_core;
 
-		$str_info = "[XE Server Environment " . date("Y-m-d") . "]\n\n";
+		$str_info = "[XE Server Environment ".date("Y-m-d")."]\n\n";
 		$str_info .= "realpath : ".realpath('./')."\n";
-		foreach( $info as $key=>$value )
+		foreach ($info as $key=>$value)
 		{
-			if( is_array( $value ) == false ) {
+			if (is_array($value) == false) {
 				$str_info .= "{$key} : {$value}\n";
 			} else {
 				//$str_info .= "\n{$key} \n";
-				foreach( $value as $key2=>$value2 )
+				foreach ($value as $key2=>$value2)
 					$str_info .= "{$key2} : {$value2}\n";
 			}
 		}
@@ -672,7 +672,7 @@ 
 		Context::set('use_rewrite', $useRewrite); 
 
 		// nginx 체크, rewrite 사용법 안내
-		if($useRewrite == 'N' && stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) Context::set('use_nginx', 'Y');
+		if ($useRewrite == 'N' && stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) Context::set('use_nginx', 'Y');
 		
 		Context::set('useable', $oInstallController->checkInstallEnv());
 		$this->setTemplateFile('check_env.html');

Braces +23 added lines, -13 removed lines

@@ -31,8 +31,7 @@ 
 		if(strpos($db_info->default_url, 'xn--') !== FALSE)
 		{
 			$xe_default_url = Context::decodeIdna($db_info->default_url);
-		}
-		else
+		} else
 		{
 			$xe_default_url = $db_info->default_url;
 		}
@@ -434,9 +433,15 @@ 
 
 		// site lock
 		Context::set('IP', $_SERVER['REMOTE_ADDR']);
-		if(!$db_info->sitelock_title) $db_info->sitelock_title = 'Maintenance in progress...';
-		if(!in_array('127.0.0.1', $db_info->sitelock_whitelist)) $db_info->sitelock_whitelist[] = '127.0.0.1';
-		if(!in_array($_SERVER['REMOTE_ADDR'], $db_info->sitelock_whitelist)) $db_info->sitelock_whitelist[] = $_SERVER['REMOTE_ADDR'];
+		if(!$db_info->sitelock_title) {
+			$db_info->sitelock_title = 'Maintenance in progress...';
+		}
+		if(!in_array('127.0.0.1', $db_info->sitelock_whitelist)) {
+			$db_info->sitelock_whitelist[] = '127.0.0.1';
+		}
+		if(!in_array($_SERVER['REMOTE_ADDR'], $db_info->sitelock_whitelist)) {
+			$db_info->sitelock_whitelist[] = $_SERVER['REMOTE_ADDR'];
+		}
 		$db_info->sitelock_whitelist = array_unique($db_info->sitelock_whitelist);
 		Context::set('remote_addr', $_SERVER['REMOTE_ADDR']);
 		Context::set('use_sitelock', $db_info->use_sitelock);
@@ -447,8 +452,11 @@ 
 		Context::set('sitelock_whitelist', $whitelist);
 
 
-		if($db_info->admin_ip_list) $admin_ip_list = implode("\r\n", $db_info->admin_ip_list);
-		else $admin_ip_list = '';
+		if($db_info->admin_ip_list) {
+			$admin_ip_list = implode("\r\n", $db_info->admin_ip_list);
+		} else {
+			$admin_ip_list = '';
+		}
 		Context::set('admin_ip_list', $admin_ip_list);
 
 		Context::set('lang_selected', Context::loadLangSelected());
@@ -547,8 +555,7 @@ 
 			Context::addHtmlFooter($img);
 
 			FileHandler::writeFile($path . $mainVersion, '1');
-		}
-		else if(isset($_SESSION['enviroment_gather']) && !file_exists(FileHandler::getRealPath($path . $mainVersion)))
+		} else if(isset($_SESSION['enviroment_gather']) && !file_exists(FileHandler::getRealPath($path . $mainVersion)))
 		{
 			if($_SESSION['enviroment_gather'] == 'Y')
 			{
@@ -580,7 +587,7 @@ 
 			$arr = explode("=", $value);
 			if($arr[0]=="type") {
 				continue;
-			}elseif($arr[0]=="phpext" ) {
+			} elseif($arr[0]=="phpext" ) {
 				$str = urldecode($arr[1]);
 				$xe_check_env[$arr[0]]= str_replace("|", ", ", $str);
 			} elseif($arr[0]=="module" ) {
@@ -655,8 +662,9 @@ 
 				$str_info .= "{$key} : {$value}\n";
 			} else {
 				//$str_info .= "\n{$key} \n";
-				foreach( $value as $key2=>$value2 )
-					$str_info .= "{$key2} : {$value2}\n";
+				foreach( $value as $key2=>$value2 ) {
+									$str_info .= "{$key2} : {$value2}\n";
+				}
 			}
 		}
 
@@ -672,7 +680,9 @@ 
 		Context::set('use_rewrite', $useRewrite); 
 
 		// nginx 체크, rewrite 사용법 안내
-		if($useRewrite == 'N' && stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) Context::set('use_nginx', 'Y');
+		if($useRewrite == 'N' && stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) {
+			Context::set('use_nginx', 'Y');
+		}
 		
 		Context::set('useable', $oInstallController->checkInstallEnv());
 		$this->setTemplateFile('check_env.html');

modules/adminlogging/adminlogging.controller.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 
 	/**
 	 * Initialization
-	 * @return void
+	 * @return ModuleObject|null
 	 */
 	function init()
 	{

Spacing +2 added lines, -2 removed lines

@@ -21,7 +21,7 @@ 
 		// forbit access if the user is not an administrator
 		$oMemberModel = getModel('member');
 		$logged_info = $oMemberModel->getLoggedInfo();
-		if($logged_info->is_admin != 'Y')
+		if ($logged_info->is_admin != 'Y')
 		{
 			return $this->stop("msg_is_not_administrator");
 		}
@@ -33,7 +33,7 @@ 
 	 */
 	function insertLog($module, $act)
 	{
-		if(!$module || !$act)
+		if (!$module || !$act)
 		{
 			return;
 		}

modules/autoinstall/autoinstall.admin.controller.php

Doc Comments +1 added lines

@@ -332,6 +332,7 @@
 	/**
 	 * Uninstall package by package serial number
 	 *
+	 * @param string $package_srl
 	 * @return Object
 	 */
 	function uninstallPackageByPackageSrl($package_srl)

Braces +13 added lines, -26 removed lines

@@ -104,8 +104,7 @@ 
 			if($type == "core")
 			{
 				$version = __XE_VERSION__;
-			}
-			else
+			} else
 			{
 				$config_file = NULL;
 				switch($type)
@@ -161,8 +160,7 @@ 
 			if(version_compare($args->version, $args->current_version, ">"))
 			{
 				$args->need_update = "Y";
-			}
-			else
+			} else
 			{
 				$args->need_update = "N";
 			}
@@ -187,8 +185,7 @@ 
 		if(!$_SESSION['ftp_password'])
 		{
 			$ftp_password = Context::get('ftp_password');
-		}
-		else
+		} else
 		{
 			$ftp_password = $_SESSION['ftp_password'];
 		}
@@ -200,16 +197,13 @@ 
 			if($oAdminModel->checkUseDirectModuleInstall($package)->toBool())
 			{
 				$oModuleInstaller = new DirectModuleInstaller($package);
-			}
-			else if($ftp_info->sftp && $ftp_info->sftp == 'Y' && $isSftpSupported)
+			} else if($ftp_info->sftp && $ftp_info->sftp == 'Y' && $isSftpSupported)
 			{
 				$oModuleInstaller = new SFTPModuleInstaller($package);
-			}
-			else if(function_exists(ftp_connect))
+			} else if(function_exists(ftp_connect))
 			{
 				$oModuleInstaller = new PHPFTPModuleInstaller($package);
-			}
-			else
+			} else
 			{
 				$oModuleInstaller = new FTPModuleInstaller($package);
 			}
@@ -230,8 +224,7 @@ 
 		if(Context::get('return_url'))
 		{
 			$this->setRedirectUrl(Context::get('return_url'));
-		}
-		else
+		} else
 		{
 			$this->setRedirectUrl(preg_replace('/act=[^&]*/', 'act=dispAutoinstallAdminIndex', Context::get('error_return_url')));
 		}
@@ -265,8 +258,7 @@ 
 			if($oModel->getPackage($args->package_srl))
 			{
 				$output = executeQuery("autoinstall.updatePackage", $args);
-			}
-			else
+			} else
 			{
 				$output = executeQuery("autoinstall.insertPackage", $args);
 				if(!$output->toBool())
@@ -322,8 +314,7 @@ 
 		if(Context::get('return_url'))
 		{
 			$this->setRedirectUrl(Context::get('return_url'));
-		}
-		else
+		} else
 		{
 			$this->setRedirectUrl(getNotEncodedUrl('', 'module', 'admin', 'act', 'dispAutoinstallAdminInstalledPackages'));
 		}
@@ -362,8 +353,7 @@ 
 		if(!$_SESSION['ftp_password'])
 		{
 			$ftp_password = Context::get('ftp_password');
-		}
-		else
+		} else
 		{
 			$ftp_password = $_SESSION['ftp_password'];
 		}
@@ -373,16 +363,13 @@ 
 		if($oAdminModel->checkUseDirectModuleInstall($package)->toBool())
 		{
 			$oModuleInstaller = new DirectModuleInstaller($package);
-		}
-		else if($ftp_info->sftp && $ftp_info->sftp == 'Y' && $isSftpSupported)
+		} else if($ftp_info->sftp && $ftp_info->sftp == 'Y' && $isSftpSupported)
 		{
 			$oModuleInstaller = new SFTPModuleInstaller($package);
-		}
-		else if(function_exists('ftp_connect'))
+		} else if(function_exists('ftp_connect'))
 		{
 			$oModuleInstaller = new PHPFTPModuleInstaller($package);
-		}
-		else
+		} else
 		{
 			$oModuleInstaller = new FTPModuleInstaller($package);
 		}

Spacing +32 added lines, -32 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 /* Copyright (C) NAVER <http://www.navercorp.com> */
 
-require_once(_XE_PATH_ . 'modules/autoinstall/autoinstall.lib.php');
+require_once(_XE_PATH_.'modules/autoinstall/autoinstall.lib.php');
 
 /**
  * autoinstall module admin controller class
@@ -64,7 +64,7 @@ 
 	{
 		$oModel = getModel('autoinstall');
 		$item = $oModel->getLatestPackage();
-		if($item)
+		if ($item)
 		{
 			$params["updatedate"] = $item->updatedate;
 		}
@@ -92,23 +92,23 @@ 
 		executeQuery("autoinstall.deleteInstalledPackage");
 		$oModel = getModel('autoinstall');
 		$packages = $oModel->getPackages();
-		foreach($packages as $package)
+		foreach ($packages as $package)
 		{
 			$real_path = FileHandler::getRealPath($package->path);
-			if(!file_exists($real_path))
+			if (!file_exists($real_path))
 			{
 				continue;
 			}
 
 			$type = $oModel->getTypeFromPath($package->path);
-			if($type == "core")
+			if ($type == "core")
 			{
 				$version = __XE_VERSION__;
 			}
 			else
 			{
 				$config_file = NULL;
-				switch($type)
+				switch ($type)
 				{
 					case "m.layout":
 						$type = "layout";
@@ -138,15 +138,15 @@ 
 						break;
 				}
 
-				if(!$config_file)
+				if (!$config_file)
 				{
 					continue;
 				}
 
 				$xml = new XmlParser();
-				$xmlDoc = $xml->loadXmlFile($real_path . $config_file);
+				$xmlDoc = $xml->loadXmlFile($real_path.$config_file);
 
-				if(!$xmlDoc)
+				if (!$xmlDoc)
 				{
 					continue;
 				}
@@ -158,7 +158,7 @@ 
 			$args->package_srl = $package->package_srl;
 			$args->version = $package->version;
 			$args->current_version = $version;
-			if(version_compare($args->version, $args->current_version, ">"))
+			if (version_compare($args->version, $args->current_version, ">"))
 			{
 				$args->need_update = "Y";
 			}
@@ -184,7 +184,7 @@ 
 		$oAdminModel = getAdminModel('autoinstall');
 		$packages = explode(',', $package_srls);
 		$ftp_info = Context::getFTPInfo();
-		if(!$_SESSION['ftp_password'])
+		if (!$_SESSION['ftp_password'])
 		{
 			$ftp_password = Context::get('ftp_password');
 		}
@@ -194,18 +194,18 @@ 
 		}
 
 		$isSftpSupported = function_exists(ssh2_sftp);
-		foreach($packages as $package_srl)
+		foreach ($packages as $package_srl)
 		{
 			$package = $oModel->getPackage($package_srl);
-			if($oAdminModel->checkUseDirectModuleInstall($package)->toBool())
+			if ($oAdminModel->checkUseDirectModuleInstall($package)->toBool())
 			{
 				$oModuleInstaller = new DirectModuleInstaller($package);
 			}
-			else if($ftp_info->sftp && $ftp_info->sftp == 'Y' && $isSftpSupported)
+			else if ($ftp_info->sftp && $ftp_info->sftp == 'Y' && $isSftpSupported)
 			{
 				$oModuleInstaller = new SFTPModuleInstaller($package);
 			}
-			else if(function_exists(ftp_connect))
+			else if (function_exists(ftp_connect))
 			{
 				$oModuleInstaller = new PHPFTPModuleInstaller($package);
 			}
@@ -217,7 +217,7 @@ 
 			$oModuleInstaller->setServerUrl(_XE_DOWNLOAD_SERVER_);
 			$oModuleInstaller->setPassword($ftp_password);
 			$output = $oModuleInstaller->install();
-			if(!$output->toBool())
+			if (!$output->toBool())
 			{
 				return $output;
 			}
@@ -227,7 +227,7 @@ 
 
 		$this->setMessage('success_installed', 'update');
 
-		if(Context::get('return_url'))
+		if (Context::get('return_url'))
 		{
 			$this->setRedirectUrl(Context::get('return_url'));
 		}
@@ -246,30 +246,30 @@ 
 	function updatePackages(&$xmlDoc)
 	{
 		$oModel = getModel('autoinstall');
-		if(!$xmlDoc->response->packages->item)
+		if (!$xmlDoc->response->packages->item)
 		{
 			return;
 		}
-		if(!is_array($xmlDoc->response->packages->item))
+		if (!is_array($xmlDoc->response->packages->item))
 		{
 			$xmlDoc->response->packages->item = array($xmlDoc->response->packages->item);
 		}
 		$targets = array('package_srl', 'updatedate', 'latest_item_srl', 'path', 'version', 'category_srl', 'have_instance');
-		foreach($xmlDoc->response->packages->item as $item)
+		foreach ($xmlDoc->response->packages->item as $item)
 		{
 			$args = new stdClass();
-			foreach($targets as $target)
+			foreach ($targets as $target)
 			{
 				$args->{$target} = $item->{$target}->body;
 			}
-			if($oModel->getPackage($args->package_srl))
+			if ($oModel->getPackage($args->package_srl))
 			{
 				$output = executeQuery("autoinstall.updatePackage", $args);
 			}
 			else
 			{
 				$output = executeQuery("autoinstall.insertPackage", $args);
-				if(!$output->toBool())
+				if (!$output->toBool())
 				{
 					$output = executeQuery("autoinstall.deletePackage", $args);
 					$output = executeQuery("autoinstall.insertPackage", $args);
@@ -288,12 +288,12 @@ 
 	{
 		executeQuery("autoinstall.deleteCategory");
 		$oModel = getModel('autoinstall');
-		if(!is_array($xmlDoc->response->categorylist->item))
+		if (!is_array($xmlDoc->response->categorylist->item))
 		{
 			$xmlDoc->response->categorylist->item = array($xmlDoc->response->categorylist->item);
 		}
 		$list_order = 0;
-		foreach($xmlDoc->response->categorylist->item as $item)
+		foreach ($xmlDoc->response->categorylist->item as $item)
 		{
 			$args = new stdClass();
 			$args->category_srl = $item->category_srl->body;
@@ -314,12 +314,12 @@ 
 		$package_srl = Context::get('package_srl');
 
 		$output = $this->uninstallPackageByPackageSrl($package_srl);
-		if($output->toBool()==FALSE)
+		if ($output->toBool() == FALSE)
 		{
 			return $output;
 		}
 
-		if(Context::get('return_url'))
+		if (Context::get('return_url'))
 		{
 			$this->setRedirectUrl(Context::get('return_url'));
 		}
@@ -359,7 +359,7 @@ 
 
 		$oAdminModel = getAdminModel('autoinstall');
 
-		if(!$_SESSION['ftp_password'])
+		if (!$_SESSION['ftp_password'])
 		{
 			$ftp_password = Context::get('ftp_password');
 		}
@@ -370,15 +370,15 @@ 
 		$ftp_info = Context::getFTPInfo();
 
 		$isSftpSupported = function_exists(ssh2_sftp);
-		if($oAdminModel->checkUseDirectModuleInstall($package)->toBool())
+		if ($oAdminModel->checkUseDirectModuleInstall($package)->toBool())
 		{
 			$oModuleInstaller = new DirectModuleInstaller($package);
 		}
-		else if($ftp_info->sftp && $ftp_info->sftp == 'Y' && $isSftpSupported)
+		else if ($ftp_info->sftp && $ftp_info->sftp == 'Y' && $isSftpSupported)
 		{
 			$oModuleInstaller = new SFTPModuleInstaller($package);
 		}
-		else if(function_exists('ftp_connect'))
+		else if (function_exists('ftp_connect'))
 		{
 			$oModuleInstaller = new PHPFTPModuleInstaller($package);
 		}
@@ -391,7 +391,7 @@ 
 
 		$oModuleInstaller->setPassword($ftp_password);
 		$output = $oModuleInstaller->uninstall();
-		if(!$output->toBool())
+		if (!$output->toBool())
 		{
 			return $output;
 		}

modules/autoinstall/autoinstall.admin.model.php

Doc Comments +7 added lines

@@ -15,6 +15,9 @@ 
 
 	/**
 	 * Pre process parameters
+	 * @param string $order_target
+	 * @param string $order_type
+	 * @param string $page
 	 */
 	function preProcParam(&$order_target, &$order_type, &$page)
 	{
@@ -115,6 +118,10 @@ 
 
 	/**
 	 * Get Package List
+	 * @param string $type
+	 * @param string $search_keyword
+	 * @param integer $category_srl
+	 * @param string $parent_program
 	 */
 	function getPackageList($type, $order_target = 'newest', $order_type = 'desc', $page = '1', $search_keyword = NULL, $category_srl = NULL, $parent_program = NULL)
 	{

Spacing +43 added lines, -43 removed lines

@@ -19,19 +19,19 @@ 
 	function preProcParam(&$order_target, &$order_type, &$page)
 	{
 		$order_target_array = array('newest' => 1, 'download' => 1, 'popular' => 1);
-		if(!isset($order_target_array[$order_target]))
+		if (!isset($order_target_array[$order_target]))
 		{
 			$order_target = 'newest';
 		}
 
 		$order_type_array = array('asc' => 1, 'desc' => 1);
-		if(!isset($order_type_array[$order_type]))
+		if (!isset($order_type_array[$order_type]))
 		{
 			$order_type = 'desc';
 		}
 
 		$page = (int) $page;
-		if($page < 1)
+		if ($page < 1)
 		{
 			$page = 1;
 		}
@@ -63,12 +63,12 @@ 
 
 		$type_array = array('M' => 1, 'P' => 1);
 		$type = Context::get('type');
-		if(!isset($type_array[$type]))
+		if (!isset($type_array[$type]))
 		{
 			$type = 'P';
 		}
 
-		if($type == 'P')
+		if ($type == 'P')
 		{
 			$category_srl = $this->layout_category_srl;
 		}
@@ -95,12 +95,12 @@ 
 
 		$type_array = array('M' => 1, 'P' => 1);
 		$type = Context::get('type');
-		if(!isset($type_array[$type]))
+		if (!isset($type_array[$type]))
 		{
 			$type = 'P';
 		}
 
-		if($type == 'P')
+		if ($type == 'P')
 		{
 			$category_srl = $this->module_skin_category_srl;
 		}
@@ -118,11 +118,11 @@ 
 	 */
 	function getPackageList($type, $order_target = 'newest', $order_type = 'desc', $page = '1', $search_keyword = NULL, $category_srl = NULL, $parent_program = NULL)
 	{
-		if($type == 'menu')
+		if ($type == 'menu')
 		{
 			$params["act"] = "getResourceapiMenuPackageList";
 		}
-		elseif($type == 'skin')
+		elseif ($type == 'skin')
 		{
 			$params["act"] = "getResourceapiSkinPackageList";
 			$params['parent_program'] = $parent_program;
@@ -137,18 +137,18 @@ 
 		$params["order_type"] = $order_type;
 		$params["page"] = $page;
 
-		if($category_srl)
+		if ($category_srl)
 		{
 			$params["category_srl"] = $category_srl;
 		}
 
-		if($search_keyword)
+		if ($search_keyword)
 		{
 			$params["search_keyword"] = $search_keyword;
 		}
 
 		$xmlDoc = XmlGenerater::getXmlDoc($params);
-		if($xmlDoc && $xmlDoc->response->packagelist->item)
+		if ($xmlDoc && $xmlDoc->response->packagelist->item)
 		{
 			$item_list = $oAdminView->rearranges($xmlDoc->response->packagelist->item);
 			$this->add('item_list', $item_list);
@@ -169,14 +169,14 @@ 
 		
 		$is_authed = 0;
 		$output = $oAdminModel->checkUseDirectModuleInstall($package);
-		if($output->toBool()==TRUE)
+		if ($output->toBool() == TRUE)
 		{
 			$is_authed = 1;
 		}
 		else
 		{
 			$ftp_info = Context::getFTPInfo();
-			if(!$ftp_info->ftp_root_path)
+			if (!$ftp_info->ftp_root_path)
 			{
 				$is_authed = -1;
 			}
@@ -196,14 +196,14 @@ 
 	{
 		$oModel = getModel('autoinstall');
 		$output = executeQueryArray('autoinstall.getNeedUpdate');
-		if(!is_array($output->data))
+		if (!is_array($output->data))
 		{
 			return NULL;
 		}
 
 		$result = array();
 		$xml = new XmlParser();
-		foreach($output->data as $package)
+		foreach ($output->data as $package)
 		{
 			$packageSrl = $package->package_srl;
 
@@ -213,27 +213,27 @@ 
 			$packageInfo->type = $oModel->getTypeFromPath($package->path);
 			$packageInfo->url = $oModel->getUpdateUrlByPackageSrl($package->package_srl);
 
-			if($packageInfo->type == 'core')
+			if ($packageInfo->type == 'core')
 			{
 				$title = 'XpressEngine';
 			}
 			else
 			{
 				$configFile = $oModel->getConfigFilePath($packageInfo->type);
-				$xmlDoc = $xml->loadXmlFile(FileHandler::getRealPath($package->path) . $configFile);
+				$xmlDoc = $xml->loadXmlFile(FileHandler::getRealPath($package->path).$configFile);
 
-				if($xmlDoc)
+				if ($xmlDoc)
 				{
 					$type = $packageInfo->type;
-					if($type == "drcomponent")
+					if ($type == "drcomponent")
 					{
 						$type = "component";
 					}
-					if($type == "style" || $type == "m.skin")
+					if ($type == "style" || $type == "m.skin")
 					{
 						$type = "skin";
 					}
-					if($type == "m.layout")
+					if ($type == "m.layout")
 					{
 						$type = "layout";
 					}
@@ -267,7 +267,7 @@ 
 		$oModel = getModel('autoinstall');
 
 		$targetpackages = array();
-		if($xmlDoc)
+		if ($xmlDoc)
 		{
 			$xmlPackage = $xmlDoc->response->package;
 			$package = new stdClass();
@@ -276,15 +276,15 @@ 
 			$package->package_description = $xmlPackage->package_description->body;
 			$package->version = $xmlPackage->version->body;
 			$package->path = $xmlPackage->path->body;
-			if($xmlPackage->depends)
+			if ($xmlPackage->depends)
 			{
-				if(!is_array($xmlPackage->depends->item))
+				if (!is_array($xmlPackage->depends->item))
 				{
 					$xmlPackage->depends->item = array($xmlPackage->depends->item);
 				}
 
 				$package->depends = array();
-				foreach($xmlPackage->depends->item as $item)
+				foreach ($xmlPackage->depends->item as $item)
 				{
 					$dep_item = new stdClass();
 					$dep_item->package_srl = $item->package_srl->body;
@@ -297,23 +297,23 @@ 
 
 				$packages = $oModel->getInstalledPackages(array_keys($targetpackages));
 				$package->deplist = "";
-				foreach($package->depends as $key => $dep)
+				foreach ($package->depends as $key => $dep)
 				{
-					if(!$packages[$dep->package_srl])
+					if (!$packages[$dep->package_srl])
 					{
 						$package->depends[$key]->installed = FALSE;
-						$package->package_srl .= "," . $dep->package_srl;
+						$package->package_srl .= ",".$dep->package_srl;
 					}
 					else
 					{
 						$package->depends[$key]->installed = TRUE;
 						$package->depends[$key]->cur_version = $packages[$dep->package_srl]->current_version;
-						if(version_compare($dep->version, $packages[$dep->package_srl]->current_version, ">"))
+						if (version_compare($dep->version, $packages[$dep->package_srl]->current_version, ">"))
 						{
 							$package->depends[$key]->need_update = TRUE;
-							$package->package_srl .= "," . $dep->package_srl;
+							$package->package_srl .= ",".$dep->package_srl;
 
-							if($dep->path === '.')
+							if ($dep->path === '.')
 							{
 								$package->contain_core = TRUE;
 								$package->contain_core_version = $dep->version;
@@ -328,14 +328,14 @@ 
 			}
 
 			$installedPackage = $oModel->getInstalledPackage($packageSrl);
-			if($installedPackage)
+			if ($installedPackage)
 			{
 				$package->installed = TRUE;
 				$package->cur_version = $installedPackage->current_version;
 				$package->need_update = version_compare($package->version, $installedPackage->current_version, ">");
 			}
 
-			if($package->path === '.')
+			if ($package->path === '.')
 			{
 				$package->contain_core = TRUE;
 				$package->contain_core_version = $package->version;
@@ -351,7 +351,7 @@ 
 	public function getAutoInstallAdminInstallInfo()
 	{
 		$packageSrl = Context::get('package_srl');
-		if(!$packageSrl)
+		if (!$packageSrl)
 		{
 			return new Object(-1, 'msg_invalid_request');
 		}
@@ -365,23 +365,23 @@ 
 		$directModuleInstall = TRUE;
 		$arrUnwritableDir = array();
 		$output = $this->isWritableDir($package->path);
-		if($output->toBool()==FALSE)
+		if ($output->toBool() == FALSE)
 		{
 			$directModuleInstall = FALSE;
 			$arrUnwritableDir[] = $output->get('path');
 		}
 
-		foreach($package->depends as $dep)
+		foreach ($package->depends as $dep)
 		{
 			$output = $this->isWritableDir($dep->path);
-			if($output->toBool()==FALSE)
+			if ($output->toBool() == FALSE)
 			{
 				$directModuleInstall = FALSE;
 				$arrUnwritableDir[] = $output->get('path');
 			}
 		}
 
-		if($directModuleInstall==FALSE)
+		if ($directModuleInstall == FALSE)
 		{
 			$output = new Object(-1, 'msg_direct_inall_invalid');
 			$output->add('path', $arrUnwritableDir);
@@ -396,17 +396,17 @@ 
 		$path_list = explode('/', dirname($path));
 		$real_path = './';
 
-		while($path_list)
+		while ($path_list)
 		{
-			$check_path = realpath($real_path . implode('/', $path_list));
-			if(FileHandler::isDir($check_path))
+			$check_path = realpath($real_path.implode('/', $path_list));
+			if (FileHandler::isDir($check_path))
 			{
 				break;
 			}
 			array_pop($path_list);
 		}
 
-		if(FileHandler::isWritableDir($check_path)==FALSE)
+		if (FileHandler::isWritableDir($check_path) == FALSE)
 		{
 			$output = new Object(-1, 'msg_unwritable_directory');
 			$output->add('path', FileHandler::getRealPath($check_path));

Braces +10 added lines, -20 removed lines

@@ -71,8 +71,7 @@ 
 		if($type == 'P')
 		{
 			$category_srl = $this->layout_category_srl;
-		}
-		else
+		} else
 		{
 			$category_srl = $this->mobile_layout_category_srl;
 		}
@@ -103,8 +102,7 @@ 
 		if($type == 'P')
 		{
 			$category_srl = $this->module_skin_category_srl;
-		}
-		else
+		} else
 		{
 			$category_srl = $this->module_mobile_skin_category_srl;
 		}
@@ -121,13 +119,11 @@ 
 		if($type == 'menu')
 		{
 			$params["act"] = "getResourceapiMenuPackageList";
-		}
-		elseif($type == 'skin')
+		} elseif($type == 'skin')
 		{
 			$params["act"] = "getResourceapiSkinPackageList";
 			$params['parent_program'] = $parent_program;
-		}
-		else
+		} else
 		{
 			$params["act"] = "getResourceapiPackagelist";
 		}
@@ -172,15 +168,13 @@ 
 		if($output->toBool()==TRUE)
 		{
 			$is_authed = 1;
-		}
-		else
+		} else
 		{
 			$ftp_info = Context::getFTPInfo();
 			if(!$ftp_info->ftp_root_path)
 			{
 				$is_authed = -1;
-			}
-			else
+			} else
 			{
 				$is_authed = (int) isset($_SESSION['ftp_password']);
 			}
@@ -216,8 +210,7 @@ 
 			if($packageInfo->type == 'core')
 			{
 				$title = 'XpressEngine';
-			}
-			else
+			} else
 			{
 				$configFile = $oModel->getConfigFilePath($packageInfo->type);
 				$xmlDoc = $xml->loadXmlFile(FileHandler::getRealPath($package->path) . $configFile);
@@ -238,8 +231,7 @@ 
 						$type = "layout";
 					}
 					$title = $xmlDoc->{$type}->title->body;
-				}
-				else
+				} else
 				{
 					$pathInfo = explode('/', $package->path);
 					$title = $pathInfo[count($pathInfo) - 1];
@@ -303,8 +295,7 @@ 
 					{
 						$package->depends[$key]->installed = FALSE;
 						$package->package_srl .= "," . $dep->package_srl;
-					}
-					else
+					} else
 					{
 						$package->depends[$key]->installed = TRUE;
 						$package->depends[$key]->cur_version = $packages[$dep->package_srl]->current_version;
@@ -318,8 +309,7 @@ 
 								$package->contain_core = TRUE;
 								$package->contain_core_version = $dep->version;
 							}
-						}
-						else
+						} else
 						{
 							$package->need_update = FALSE;
 						}