Commit: 4c95e67671984c5246931362affb33f06c888d06 - pukiwiki-fork (git)

Commit MetaInfo

• Revision: 4c95e67671984c5246931362affb33f06c888d06 (tree)
• Zeit: 2011-02-06 22:50:46
• Autor: henoheno <henoheno>
• Commiter: henoheno

Log Message

BugTrack2/343 BugTrack/779: Cleanup transition (1):
* Japanese comments => English ones
* &ref(); without arg shows its usage
* Remove comments that the souce already said
* Simplify renaming variables
* Simplify using htmlsc()
* Simplifying $params (to be continued)
* Simplifying $width/$height (to be continued)

Ändern Zusammenfassung

• modified: plugin/ref.inc.php

Diff

--- a/plugin/ref.inc.php
+++ b/plugin/ref.inc.php
@@ -1,6 +1,6 @@
 <?php
 // PukiWiki - Yet another WikiWikiWeb clone
-// $Id: ref.inc.php,v 1.53 2011/02/03 15:03:10 henoheno Exp $
+// $Id: ref.inc.php,v 1.54 2011/02/06 13:50:46 henoheno Exp $
 // Copyright (C)
 //   2002-2006, 2011 PukiWiki Developers Team
 //   2001-2002 Originally written by yu-ji
@@ -25,18 +25,15 @@ define('PLUGIN_REF_DEFAULT_ALIGN', 'left'); // 'left', 'center', 'right'
 // Text wrapping
 define('PLUGIN_REF_WRAP_TABLE', FALSE); // TRUE, FALSE
 
-// URL指定時に画像サイズを取得するか
+// NOT RECOMMENDED: getimagesize($uri) for proper width/height
 define('PLUGIN_REF_URL_GET_IMAGE_SIZE', FALSE); // FALSE, TRUE
 
-// UPLOAD_DIR のデータ(画像ファイルのみ)に直接アクセスさせる
+// DANGER, DO NOT USE THIS: Allow direct access to UPLOAD_DIR
 define('PLUGIN_REF_DIRECT_ACCESS', FALSE); // FALSE or TRUE
-// - これは従来のインラインイメージ処理を互換のために残すもので
-//   あり、高速化のためのオプションではありません
-// - UPLOAD_DIR をWebサーバー上に露出させており、かつ直接アクセス
-//   できる(アクセス制限がない)状態である必要があります
-// - Apache などでは UPLOAD_DIR/.htaccess を削除する必要があります
-// - ブラウザによってはインラインイメージの表示や、「インライン
-//   イメージだけを表示」させた時などに不具合が出る場合があります
+// - This is NOT option for acceralation but old and compatible.
+// - Apache: UPLOAD_DIR/.htaccess will prohibit this usage.
+// - Browsers: This usage contains any proper mime-type, so
+//   some ones will not show proper result. And may cause XSS.
 
 /////////////////////////////////////////////////
 
@@ -48,42 +45,41 @@ define('PLUGIN_REF_USAGE', '([pagename/]attached-file-name[,parameters, ... ][,t
 
 function plugin_ref_inline()
 {
-	// Not reached, because of "$aryargs[] = & $body" at plugin.php
-	// if (! func_num_args())
-	//	return '&amp;ref(): Usage:' . PLUGIN_REF_USAGE . ';';
+	// "$aryargs[] = & $body" at plugin.php
+	if (func_num_args() == 1) {
+		return htmlsc('&ref(): Usage:' . PLUGIN_REF_USAGE . ';');
+	}
 
 	$params = plugin_ref_body(func_get_args());
-
 	if (isset($params['_error']) && $params['_error'] != '') {
-		// Error
-		return '&amp;ref(): ' . $params['_error'] . ';';
-	} else {
-		return $params['_body'];
+		return htmlsc('&ref(): ' . $params['_error'] . ';');
 	}
+
+	return $params['_body'];
 }
 
 function plugin_ref_convert()
 {
-	if (! func_num_args())
-		return '<p>#ref(): Usage:' . PLUGIN_REF_USAGE . '</p>' . "\n";
+	if (! func_num_args()) {
+		return '<p>' . htmlsc('#ref(): Usage:' . PLUGIN_REF_USAGE) . '</p>' . "\n";
+	}
 
 	$params = plugin_ref_body(func_get_args());
-
 	if (isset($params['_error']) && $params['_error'] != '') {
-		return '<p>#ref(): ' . $params['_error'] . '</p>' . "\n";
+		return '<p>' . htmlsc('#ref(): ' . $params['_error']) . '</p>' . "\n";
 	}
 
+	// Wrap with a table
 	if ((PLUGIN_REF_WRAP_TABLE && ! $params['nowrap']) || $params['wrap']) {
-		// 枠で包む
 		// margin:auto
-		//	Mozilla 1.x  = x (wrap,aroundが効かない)
+		//	Mozilla 1.x  = x (wrap, and around are ignored)
 		//	Opera 6      = o
-		//	Netscape 6   = x (wrap,aroundが効かない)
-		//	IE 6         = x (wrap,aroundが効かない)
+		//	Netscape 6   = x (wrap, and around are ignored)
+		//	IE 6         = x (wrap, and around are ignored)
 		// margin:0px
-		//	Mozilla 1.x  = x (wrapで寄せが効かない)
-		//	Opera 6      = x (wrapで寄せが効かない)
-		//	Netscape 6   = x (wrapで寄せが効かない)
+		//	Mozilla 1.x  = x (aligning seems ignored with wrap)
+		//	Opera 6      = x (aligning seems ignored with wrap)
+		//	Netscape 6   = x (aligning seems ignored with wrap)
 		//	IE6          = o
 		$margin = ($params['around'] ? '0px' : 'auto');
 		$margin_align = ($params['_align'] == 'center') ? '' :
@@ -102,195 +98,181 @@ EOD;
 	} else {
 		$style = 'text-align:' . $params['_align'];
 	}
-
-	// divで包む
-	return '<div class="img_margin" style="' . $style . '">' . $params['_body'] . '</div>' . "\n";
+	return '<div class="img_margin" style="' . htmlsc($style) . '">' .
+		$params['_body'] . '</div>' . "\n";
 }
 
+// Common function
 function plugin_ref_body($args)
 {
 	global $script, $vars;
-	global $WikiName, $BracketName; // compat
+	global $WikiName, $BracketName;
+
+	$page = isset($vars['page']) ? $vars['page'] : '';
 
-	// 戻り値
 	$params = array(
-		'left'   => FALSE, // 左寄せ
-		'center' => FALSE, // 中央寄せ
-		'right'  => FALSE, // 右寄せ
-		'wrap'   => FALSE, // TABLEで囲む
-		'nowrap' => FALSE, // TABLEで囲まない
-		'around' => FALSE, // 回り込み
-		'noicon' => FALSE, // アイコンを表示しない
-		'nolink' => FALSE, // 元ファイルへのリンクを張らない
-		'noimg'  => FALSE, // 画像を展開しない
-		'zoom'   => FALSE, // 縦横比を保持する
-		'_size'  => FALSE, // サイズ指定あり
-		'_w'     => 0,     // 幅
-		'_h'     => 0,     // 高さ
-		'_%'     => 0,     // 拡大率
+		// Align
+		'left'   => FALSE,
+		'center' => FALSE,
+		'right'  => FALSE,
+		'_align' => PLUGIN_REF_DEFAULT_ALIGN,
+
+		// Wrap with table or not
+		'wrap'   => FALSE,
+		'nowrap' => FALSE,
+
+		'around' => FALSE, // wrap around
+		'noicon' => FALSE, // Suppress showing icon
+		'nolink' => FALSE, // Suppress link to image itself
+		'noimg'  => FALSE, // Suppress showing image
+
+		'zoom'   => FALSE, // Image size spacified
+		'_%'     => 0,     // percentage
+
+		'_size'  => FALSE, // Image size specified
+		'_w'     => 0,     // width
+		'_h'     => 0,     // height
+
 		'_args'  => array(),
 		'_done'  => FALSE,
 		'_error' => ''
 	);
 
-	// 添付ファイルのあるページ: defaultは現在のページ名
-	$page = isset($vars['page']) ? $vars['page'] : '';
-
-	// 添付ファイルのファイル名
-	$name = '';
+	// [Page_name/maybe-separated-with/slashes/]AttachedFileName.sfx or URI
+	$name    = array_shift($args);
+	$is_url  = is_url($name);
 
-	// 添付ファイルまでのパスおよび(実際の)ファイル名
-	$file = '';
-
-	// 第一引数: "[ページ名および/]添付ファイル名"、あるいは"URL"を取得
-	$name = array_shift($args);
-	$is_url = is_url($name);
+	$file    = ''; // Path to the attached file
+	$is_file = FALSE;
 
 	if(! $is_url) {
-		// 添付ファイル
 		if (! is_dir(UPLOAD_DIR)) {
 			$params['_error'] = 'No UPLOAD_DIR';
 			return $params;
 		}
 
 		$matches = array();
-		// ファイル名にページ名(ページ参照パス)が合成されているか
-		//   (Page_name/maybe-separated-with/slashes/ATTACHED_FILENAME)
 		if (preg_match('#^(.+)/([^/]+)$#', $name, $matches)) {
+			// Page_name/maybe-separated-with/slashes and AttachedFileName.sfx
 			if ($matches[1] == '.' || $matches[1] == '..') {
 				$matches[1] .= '/'; // Restore relative paths
 			}
-			$name = $matches[2];
-			$page = get_fullname(strip_bracket($matches[1]), $page); // strip is a compat
-			$file = UPLOAD_DIR . encode($page) . '_' . encode($name);
+			$name    = $matches[2]; // AttachedFileName.sfx
+			$page    = get_fullname(strip_bracket($matches[1]), $page); // strip is a compat
+			$file    = UPLOAD_DIR . encode($page) . '_' . encode($name);
 			$is_file = is_file($file);
 
-		// 第二引数以降が存在し、それはrefのオプション名称などと一致しない
 		} else if (isset($args[0]) && $args[0] != '' && ! isset($params[$args[0]])) {
-			$e_name = encode($name);
-
-			// Try the second argument, as a page-name or a path-name
-			$_arg = get_fullname(strip_bracket($args[0]), $page); // strip is a compat
-			$file = UPLOAD_DIR .  encode($_arg) . '_' . $e_name;
-			$is_file_second = is_file($file);
+			// Is the second argument a page-name or a path-name?
+			$_page = array_shift($args);
 
-			// If the second argument is WikiName, or double-bracket-inserted pagename (compat)
-			$is_bracket_bracket = preg_match('/^(' . $WikiName . '|\[\[' . $BracketName . '\]\])$/', $args[0]);
+			// Looks like WikiName, or double-bracket-inserted pagename? (compat)
+			$is_bracket_bracket = preg_match('/^(' . $WikiName . '|\[\[' . $BracketName . '\]\])$/', $_page);
 
-			if ($is_file_second && $is_bracket_bracket) {
-				// Believe the second argument (compat)
-				array_shift($args);
-				$page = $_arg;
-				$is_file = TRUE;
-			} else {
-				// Try default page, with default params
-				$is_file_default = is_file(UPLOAD_DIR . encode($page) . '_' . $e_name);
+			$_page   = get_fullname(strip_bracket($_page), $page); // strip is a compat
+			$file    = UPLOAD_DIR .  encode($_page) . '_' . encode($name);
+			$is_file = is_file($file);
 
+			if (! $is_bracket_bracket || ! $is_file) {
 				// Promote new design
-				if ($is_file_default && $is_file_second) {
+				if ($is_file && is_file(UPLOAD_DIR . encode($page) . '_' . encode($name))) {
 					// Because of race condition NOW
-					$params['_error'] = htmlsc('The same file name "' .
-						$name . '" at both page: "' .  $page . '" and "' .  $_arg .
-						'". Try ref(pagename/filename) to specify one of them');
+					$params['_error'] =
+						'The same file name "' . $name . '" at both page: "' .
+						$page . '" and "' .  $_page .
+						'". Try ref(pagename/filename) to specify one of them';
 				} else {
 					// Because of possibility of race condition, in the future
-					$params['_error'] = 'The style ref(filename,pagename) is ambiguous ' .
+					$params['_error'] =
+						'The style ref(filename,pagename) is ambiguous ' .
 						'and become obsolete. ' .
 						'Please try ref(pagename/filename)';
 				}
 				return $params;
 			}
+			$page = $_page; // Believe it (compat)
+
 		} else {
 			// Simple single argument
-			$file = UPLOAD_DIR . encode($page) . '_' . encode($name);
+			$file    = UPLOAD_DIR . encode($page) . '_' . encode($name);
 			$is_file = is_file($file);
 		}
+
 		if (! $is_file) {
-			$params['_error'] = htmlsc('File not found: "' .
-				$name . '" at page "' . $page . '"');
+			$params['_error'] = 'File not found: "' .
+				$name . '" at page "' . $page . '"';
 			return $params;
 		}
 	}
 
-	// 残りの引数の処理
-	if (! empty($args))
-		foreach ($args as $arg)
+	// $params
+	if (! empty($args)) {
+		foreach ($args as $arg) {
 			ref_check_arg($arg, $params);
+		}
+	}
+	foreach (array('right', 'left', 'center') as $align) {
+		if ($params[$align])  {
+			$params['_align'] = $align;
+			break;
+		}
+	}
+	$seems_image = (! $params['noimg'] && preg_match(PLUGIN_REF_IMAGE, $name));
 
-/*
- $nameをもとに以下の変数を設定
- $url,$url2 : URL
- $title :タイトル
- $is_image : 画像のときTRUE
- $info : 画像ファイルのときgetimagesize()の'size'
-         画像ファイル以外のファイルの情報
-         添付ファイルのとき : ファイルの最終更新日とサイズ
-         URLのとき : URLそのもの
-*/
-	$title = $url = $url2 = $info = '';
 	$width = $height = 0;
+	$title = $url = $url2 = '';
 	$matches = array();
 
-	if ($is_url) {	// URL
+	if ($is_url) {
+		$url   = $name;
+		$url2  = $name;
+
 		if (PKWK_DISABLE_INLINE_IMAGE_FROM_URI) {
 			//$params['_error'] = 'PKWK_DISABLE_INLINE_IMAGE_FROM_URI prohibits this';
 			//return $params;
-			$url = htmlsc($name);
-			$params['_body'] = '<a href="' . $url . '">' . $url . '</a>';
+			$s_url = htmlsc($url);
+			$params['_body'] = '<a href="' . $s_url . '">' . $s_url . '</a>';
 			return $params;
 		}
 
-		$url = $url2 = htmlsc($name);
-		$title = htmlsc(preg_match('/([^\/]+)$/', $name, $matches) ? $matches[1] : $url);
-
-		$is_image = (! $params['noimg'] && preg_match(PLUGIN_REF_IMAGE, $name));
+		$title = preg_match('#([^/]+)$#', $url, $matches) ? $matches[1] : $url;
 
-		if ($is_image && PLUGIN_REF_URL_GET_IMAGE_SIZE && (bool)ini_get('allow_url_fopen')) {
+		if (PLUGIN_REF_URL_GET_IMAGE_SIZE && $seems_image && (bool)ini_get('allow_url_fopen')) {
 			$size = @getimagesize($name);
 			if (is_array($size)) {
 				$width  = $size[0];
 				$height = $size[1];
-				$info   = $size[3];
 			}
 		}
 
-	} else { // 添付ファイル
-
-		$title = htmlsc($name);
-
-		$is_image = (! $params['noimg'] && preg_match(PLUGIN_REF_IMAGE, $name));
+	} else {
+		$title = $name;
 
 		// Count downloads with attach plugin
-		$url = $script . '?plugin=attach' . '&amp;refer=' . rawurlencode($page) .
-			'&amp;openfile=' . rawurlencode($name); // Show its filename at the last
+		$url  = $script . '?plugin=attach' . '&refer=' . rawurlencode($page) .
+			'&openfile=' . rawurlencode($name); // Show its filename at the last
+		$url2 = '';
 
-		if ($is_image) {
-			// Swap $url
-			$url2 = $url;
+		if ($seems_image) {
 
 			// URI for in-line image output
-			if (! PLUGIN_REF_DIRECT_ACCESS) {
-				// With ref plugin (faster than attach)
-				$url = $script . '?plugin=ref' . '&amp;page=' . rawurlencode($page) .
-					'&amp;src=' . rawurlencode($name); // Show its filename at the last
+			$url2 = $url;
+			if (PLUGIN_REF_DIRECT_ACCESS) {
+				$url = $file; // Try direct-access, if possible
 			} else {
-				// Try direct-access, if possible
-				$url = $file;
+				// With ref plugin (faster than attach)
+				$url = $script . '?plugin=ref' . '&page=' . rawurlencode($page) .
+					'&src=' . rawurlencode($name); // Show its filename at the last
 			}
 
-			$width = $height = 0;
 			$size = @getimagesize($file);
 			if (is_array($size)) {
 				$width  = $size[0];
 				$height = $size[1];
 			}
-		} else {
-			$info = get_date('Y/m/d H:i:s', filemtime($file) - LOCALZONE) .
-				' ' . sprintf('%01.1f', round(filesize($file)/1024, 1)) . 'KB';
 		}
 	}
 
-	// 拡張パラメータをチェック
 	if (! empty($params['_args'])) {
 		$_title = array();
 		foreach ($params['_args'] as $arg) {
@@ -308,16 +290,15 @@ function plugin_ref_body($args)
 		}
 
 		if (! empty($_title)) {
-			$title = htmlsc(join(',', $_title));
-			if ($is_image) {
-				$title = make_line_rules($title);
-			}
+			$title = join(',', $_title);
 		}
 	}
 
-	// 画像サイズ調整
-	if ($is_image) {
-		// 指定されたサイズを使用する
+	$s_url   = htmlsc($url);
+	$s_title = htmlsc($title);
+	$s_info  = '';
+	if ($seems_image) {
+		$s_title = make_line_rules($s_title);
 		if ($params['_size']) {
 			if ($width == 0 && $height == 0) {
 				$width  = $params['_w'];
@@ -327,8 +308,8 @@ function plugin_ref_body($args)
 				$_h = $params['_h'] ? $height / $params['_h'] : 0;
 				$zoom = max($_w, $_h);
 				if ($zoom) {
-					$width  = (int)($width  / $zoom);
-					$height = (int)($height / $zoom);
+					$width  = intval($width  / $zoom);
+					$height = intval($height / $zoom);
 				}
 			} else {
 				$width  = $params['_w'] ? $params['_w'] : $width;
@@ -336,53 +317,52 @@ function plugin_ref_body($args)
 			}
 		}
 		if ($params['_%']) {
-			$width  = (int)($width  * $params['_%'] / 100);
-			$height = (int)($height * $params['_%'] / 100);
+			$width  = intval($width  * $params['_%'] / 100);
+			$height = intval($height * $params['_%'] / 100);
 		}
 		if ($width && $height) {
-			$info = 'width="' . $width . '" height="' . $height . '" ';
-		}
-	}
-
-	// アラインメント判定
-	$params['_align'] = PLUGIN_REF_DEFAULT_ALIGN;
-	foreach (array('right', 'left', 'center') as $align) {
-		if ($params[$align])  {
-			$params['_align'] = $align;
-			break;
+			$s_info = 'width="'  . htmlsc($width) .
+			        '" height="' . htmlsc($height) . '" ';
 		}
-	}
-
-	if ($is_image) { // 画像
-		$params['_body'] = '<img src="' . $url . '" ' .
-			'alt="'   . $title . '" ' .
-			'title="' . $title . '" ' .
-			$info . '/>';
+		$body = '<img src="' . $s_url . '" ' .
+			'alt="'   . $s_title . '" ' .
+			'title="' . $s_title . '" ' .
+			$s_info . '/>';
 		if (! $params['nolink'] && $url2) {
 			$params['_body'] =
-				'<a href="' . $url2 . '" title="' . $title . '">' .
-				$params['_body'] . '</a>';
+				'<a href="' . htmlsc($url2) . '" title="' . $s_title . '">' .
+				$body . '</a>';
+		} else {
+			$params['_body'] = $body;
 		}
 	} else {
+		if (! $is_url) {
+			$s_info = htmlsc(get_date('Y/m/d H:i:s', filemtime($file) - LOCALZONE) .
+				' ' . sprintf('%01.1f', round(filesize($file) / 1024, 1)) . 'KB');
+		}
 		$icon = $params['noicon'] ? '' : FILE_ICON;
-		$params['_body'] = '<a href="' . $url . '" title="' . $info . '">' .
-			$icon . $title . '</a>';
+		$params['_body'] = '<a href="' . $s_url . '" title="' . $s_info . '">' .
+			$icon . $s_title . '</a>';
 	}
 
 	return $params;
 }
 
-// オプションを解析する
 function ref_check_arg($val, & $params)
 {
+	if (preg_match('/^_/', $val)) {
+		$params['_args'][] = $val;	
+		return;
+	}
 	if ($val == '') {
 		$params['_done'] = TRUE;
 		return;
 	}
 
 	if (! $params['_done']) {
+		$lval = strtolower($val);
 		foreach (array_keys($params) as $key) {
-			if (strpos($key, strtolower($val)) === 0) {
+			if (strpos($key, $lval) === 0) {
 				$params[$key] = TRUE;
 				return;
 			}
@@ -401,14 +381,14 @@ function plugin_ref_action()
 	$usage = 'Usage: plugin=ref&amp;page=page_name&amp;src=attached_image_name';
 
 	if (! isset($vars['page']) || ! isset($vars['src']))
-		return array('msg'=>'Invalid argument', 'body'=>$usage);
+		return array('msg' => 'Invalid argument', 'body' => $usage);
 
 	$page     = $vars['page'];
 	$filename = $vars['src'] ;
 
 	$ref = UPLOAD_DIR . encode($page) . '_' . encode(preg_replace('#^.*/#', '', $filename));
 	if(! file_exists($ref))
-		return array('msg'=>'Attach file not found', 'body'=>$usage);
+		return array('msg' => 'Attach file not found', 'body' => $usage);
 
 	$got = @getimagesize($ref);
 	if (! isset($got[2])) $got[2] = FALSE;
@@ -418,7 +398,7 @@ function plugin_ref_action()
 	case 3: $type = 'image/png' ; break;
 	case 4: $type = 'application/x-shockwave-flash'; break;
 	default:
-		return array('msg'=>'Seems not an image', 'body'=>$usage);
+		return array('msg' => 'Seems not an image', 'body' => $usage);
 	}
 
 	// Care for Japanese-character-included file name
@@ -433,14 +413,13 @@ function plugin_ref_action()
 			break;
 		}
 	}
-	$file = htmlsc($filename);
-	$size = filesize($ref);
 
 	// Output
+	$size = filesize($ref);
 	pkwk_common_headers();
-	header('Content-Disposition: inline; filename="' . $filename . '"');
-	header('Content-Length: ' . $size);
-	header('Content-Type: '   . $type);
+	header('Content-Disposition: inline; filename="' . htmlsc($filename) . '"');
+	header('Content-Length: ' . htmlsc($size));
+	header('Content-Type: '   . htmlsc($type));
 	@readfile($ref);
 	exit;
 }