Merge branch 'develop-ascraeus' into develop

* develop-ascraeus:
  [ticket/12941] Fix remaining Sami complaints.
  [ticket/12941] Check for Sami parse errors on Travis CI.
  [ticket/12941] Add sami.conf.php for Travis CI.

.travis.yml

@@ -37,6 +37,7 @@ before_script:
 
 script:
   - travis/phing-sniff.sh $DB $TRAVIS_PHP_VERSION
+  - travis/check-sami-parse-errors.sh $DB $TRAVIS_PHP_VERSION
   - travis/check-image-icc-profiles.sh $DB $TRAVIS_PHP_VERSION
   - travis/check-executable-files.sh $DB $TRAVIS_PHP_VERSION ./
   - phpBB/vendor/bin/phpunit --configuration travis/phpunit-$DB-travis.xml

build/sami.conf.php

@@ -45,7 +45,7 @@ $versions = Sami\Version\GitVersionCollection::create(__DIR__ . '/../')
 	->add('develop-ascraeus')
 ;
 
-return new Sami\Sami($iterator, array(
+$config = array(
 	'theme'                => 'enhanced',
 	'versions'             => $versions,
 	'title'                => 'phpBB API Documentation',
@@ -54,4 +54,6 @@ return new Sami\Sami($iterator, array(
 	'default_opened_level' => 2,
 	// Do not use JsonStore. See https://github.com/fabpot/Sami/issues/79
 	'store'                => new PhpbbArrayStore,
-));
+);
+
+return new Sami\Sami($iterator, $config);

phpBB/includes/functions_upload.php

@@ -586,6 +586,7 @@ class fileupload
 	* Upload file from users harddisk
 	*
 	* @param string $form_name Form name assigned to the file input field (if it is an array, the key has to be specified)
+	* @param \phpbb\mimetype\guesser $mimetype_guesser Mimetype guesser
 	* @param \phpbb\plupload\plupload $plupload The plupload object
 	*
 	* @return object $file Object "filespec" is returned, all further operations can be done with this object
@@ -743,6 +744,7 @@ class fileupload
 	* Uploads file from given url
 	*
 	* @param string $upload_url URL pointing to file to upload, for example http://www.foobar.com/example.gif
+	* @param \phpbb\mimetype\guesser $mimetype_guesser Mimetype guesser
 	* @return object $file Object "filespec" is returned, all further operations can be done with this object
 	* @access public
 	*/

phpBB/phpbb/avatar/driver/upload.php

@@ -27,7 +27,6 @@ class upload extends \phpbb\avatar\driver\driver
 	* Construct a driver object
 	*
 	* @param \phpbb\config\config $config phpBB configuration
-	* @param \phpbb\request\request $request Request object
 	* @param string $phpbb_root_path Path to the phpBB root
 	* @param string $php_ext PHP file extension
 	* @param \phpbb_path_helper $path_helper phpBB path helper

travis/check-sami-parse-errors.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+#
+# This file is part of the phpBB Forum Software package.
+#
+# @copyright (c) phpBB Limited <https://www.phpbb.com>
+# @license GNU General Public License, version 2 (GPL-2.0)
+#
+# For full copyright and license information, please see
+# the docs/CREDITS.txt file.
+#
+set -e
+
+DB=$1
+TRAVIS_PHP_VERSION=$2
+
+if [ "$TRAVIS_PHP_VERSION" == "5.3.3" -a "$DB" == "mysqli" ]
+then
+	# Workarounds for
+	# https://github.com/fabpot/Sami/issues/116
+	# and
+	# https://github.com/fabpot/Sami/issues/117
+	errors=$(
+		unbuffer phpBB/vendor/bin/sami.php parse travis/sami.conf.php -v | \
+		sed "s,\x1B\[[0-9;]*[a-zA-Z],,g" | \
+		grep "ERROR: " | \
+		tee /dev/tty | \
+		wc -l
+	)
+	if [ "$errors" != "0" ]
+	then
+		exit 1
+	fi
+fi

travis/sami.conf.php

@@ -0,0 +1,19 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+require __DIR__ . '/../build/' . basename(__FILE__);
+
+// Removing the versions array key will make Sami use the current branch.
+unset($config['versions']);
+
+return new Sami\Sami($iterator, $config);

travis/setup-phpbb.sh

@@ -17,6 +17,7 @@ TRAVIS_PHP_VERSION=$2
 if [ "$TRAVIS_PHP_VERSION" == "5.3.3" -a "$DB" == "mysqli" ]
 then
 	travis/setup-exiftool.sh
+	travis/setup-unbuffer.sh
 fi
 
 if [ "$DB" == "mariadb" ]

travis/setup-unbuffer.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+#
+# This file is part of the phpBB Forum Software package.
+#
+# @copyright (c) phpBB Limited <https://www.phpbb.com>
+# @license GNU General Public License, version 2 (GPL-2.0)
+#
+# For full copyright and license information, please see
+# the docs/CREDITS.txt file.
+#
+set -e
+
+sudo apt-get update
+sudo apt-get install -y expect-dev