builds.php

<?php

/**
 * Nightly builds page is built dynamically by reading the contents
 * of the /builds directory
 */


/**
 * Parsing directories in sorted order using provided callback function
 */
class SortingIterator extends ArrayIterator {
	public function __construct( Traversable $iterator, $callback ) {
		parent::__construct( iterator_to_array( $iterator ) );
		$this->uasort( $callback );
	}
}

/**
 * Retrieves the list of builds from the specified path.
 * List will be sorted by branch name ASC and time DESC, (using the zip file's
 * timestamp as reference).
 * @param string $p_path
 * @param array|null $p_builds
 * @param array|null $p_logfile
 * @return bool false in case of errors
 */
function get_builds_list(string $p_path, ?array &$p_builds, ?array &$p_logfile ): bool
{
	# Error handling in case the path does not exist
	if( !is_dir( $p_path ) ) {
		print_error( "Path '$p_path' not found" );
		return false;
	}

	# Loop over parent directories (channels)
	$t_iter_builds = new SortingIterator(
		new FileSystemIterator( $p_path ),
		'strcmp'
	);

	$p_path = '/' . basename( $p_path ) . '/';

	$p_builds = array();

	/** @var SplFileInfo $t_file */
	foreach( $t_iter_builds as $t_file ) {
		if( $t_file->isDir() ) {
			continue;
		}

		$t_file_url = $p_path . $t_file->getFilename();

		# Link to log file if present
		if( $t_file->getExtension() == 'log' ) {
			$p_logfile = array(
				'file' => $t_file_url,
				'time' => $t_file->getMTime()
			);
		} else {
			# Break down filename into components
			$t_result = preg_match(
				'/^mantisbt-(.*-?.*)-(master.*?)-(.*)\.(.*)\.?(digests|asc)?$/U',
				$t_file->getFileName(),
				$t_match
			);
			if( $t_result != 1 ) {
				continue;
			}

			$t_sha = $t_match[3];
			$t_ext = $t_match[4];

			# Build details
			$p_builds[$t_sha]['branch'] = $t_match[2];
			$p_builds[$t_sha]['version'] = $t_match[1];

			# Digest and zip/tarball file names
			if( isset( $t_match[5] ) ) {
				$p_builds[$t_sha][$t_ext][$t_match[5]] = $t_file_url;
			} else {
				$t_time = $t_file->getMTime();
				$p_builds[$t_sha][$t_ext]['file'] = $t_file_url;
				$p_builds[$t_sha][$t_ext]['time'] = $t_time;

				# Build reference time (for sorting) is the most recent file's timestamp
				$p_builds[$t_sha]['time'] = max(
					$p_builds[$t_sha]['time'] ?? 0,
					$t_time
				);
			}
		}
	}

	if( !$p_builds ) {
		print_error( "No builds found.");
		return false;
	}

	# Sort list by version DESC with master first, timestamp DESC
	uasort( $p_builds,
		function( $a, $b ) {
			$t_result = -version_compare( $a['version'], $b['version'] );
			if ($t_result == 0) {
				return -( $a['time'] <=> $b['time'] );
			}
			return $t_result;
		}
	);


	return true;
}

/**
 * Prints timestamp in YYYY-MM-DD HH:mm:ss format
 * @param int $p_time
 * @return string
 */
function print_timestamp( int $p_time ): string
{
	return date( 'Y-m-d H:i:s', $p_time );
}

/**
 * Return download links and timestamp for the file
 * @param string $p_type
 * @param array|null $p_file
 * @return string formatted markup with
 */
function print_file_details( string $p_type, ?array $p_file ): string
{
	if( is_null( $p_file ) || !isset( $p_file['file'] ) ) {
		return '
				<td class="table-cell center">Unavailable</td>';
	} else {
		$t_digest = [];
		if( isset( $p_file['asc'] ) ) {
			$t_digest[] = '<a href="' . $p_file['asc']
				. '" title="ASCII-armored signature file">signature</a>';
		}
		if( isset( $p_file['digests'] ) ) {
			$t_digest[] = '<a href="' . $p_file['digests']
				. '" title="Checksums">digests</a>';
		}
		if( $t_digest ) {
			$t_digest = implode( ', ', $t_digest );
		} else {
			$t_digest = 'no signature or digests';
		}

		/** @noinspection HtmlUnknownTarget */
		return sprintf( '
				<td class="table-cell center">
					<a href="%s"><img src="images/zip.gif" alt="%s"> Download</a>
					(%s)
					<br />
					%s
				</td>',
			$p_file['file'], $p_type,
			$t_digest,
			print_timestamp( $p_file['time'] )
		);
	}
}

/**
 * Prints the Travis-CI status icon for the given branch
 * @param string $p_branch Branch name
 * @return string
 */
function print_travis_status( string $p_branch ): string
{
	return sprintf( '
					<a href="https://app.travis-ci.com/mantisbt/mantisbt/branches">
						<img src="https://app.travis-ci.com/mantisbt/mantisbt.svg?branch=%s" 
							 alt="Build status" 
						/>
					</a>',
		$p_branch
	);
}

/**
 * Prints the table with the builds
 * @param array $p_builds
 */
function print_builds_list( array $p_builds ) {
	global $g_bugs_url;

	# printf formats
	$t_fmt_sha_link = '
					<a href="' . $g_bugs_url . 'plugin.php?page=Source/search&revision=%1$s">%1$s</a>';
	$t_fmt_branch = '
				<td rowspan="%d" class="table-cell">
					%s
					<br />%s
				</td>';
	$t_fmt_build_row = '
			<tr class="table-row">%s
				<td class="table-cell center">%s
				</td>
				%s
				%s
			</tr>' . "\n";

	# Count number of builds available for each branch
	$t_build_count = [];
	foreach( $p_builds as $t_build ) {
		$t_branch = $t_build['branch'];
		if( isset( $t_build_count[$t_branch] ) ) {
			$t_build_count[$t_branch]++;
		} else {
			$t_build_count[$t_branch] = 1;
		}
	}

	# Table header
	echo '	<!-- Downloads table -->
	<table class="table" style="padding: 2px;">
		<thead class="table-header">
			<tr class="table-row">
				<th class="table-cell" style="text-align: left;">Branch (Release)</th>
				<th class="table-cell">Commit</th>
				<th class="table-cell">Tarballs</th>
				<th class="table-cell">Zipballs</th>
			</tr>
		</thead>

		<tbody>';

	# Table body
	$t_branch = null;
	foreach( $p_builds as $t_sha => $t_build ) {
		if( $t_branch != $t_build['branch'] ) {
			$t_branch = $t_build['branch'];
			$t_current = sprintf(
				$t_fmt_branch,
				$t_build_count[$t_branch],
				sprintf(
					'%1$s<br />(%2$s)',
					$t_build['branch'],
					$t_build['version']
				),
				print_travis_status( $t_branch )
			);
		} else {
			$t_current = '';
		}

		printf(
			$t_fmt_build_row,
			$t_current,
			sprintf( $t_fmt_sha_link, $t_sha),
			print_file_details( 'tarball', $t_build['tar.gz'] ?? null),
			print_file_details( 'zipball', $t_build['zip'] ?? null)
		);
	}

	echo '
		</tbody>
	</table>

	<br />';
}

/**
 * Main body
 */

# Page header
$t_sub_title = "Nightly Builds";
include( "top.php" );

# Root of builds - try in current dir and one level above if not found
$t_dir = 'builds';
$t_path_root = rtrim( $_SERVER['DOCUMENT_ROOT'], DIRECTORY_SEPARATOR ) . DIRECTORY_SEPARATOR;
$t_path = realpath( $t_path_root . $t_dir );
if( false === $t_path ) {
	$t_path = realpath( dirname( $t_path_root ) . DIRECTORY_SEPARATOR . $t_dir );
}
if( false === $t_path ) {
	$t_path = $t_dir;
}
?>

<div class="row show-grid clear-both">
	<div class="col-sm-7 col-md-8">
		<h1>Nightly Builds Downloads</h1>
	</div>
</div>

<br>

<?php
if( get_builds_list( $t_path, $t_builds, $t_logfile ) ) {
	print_builds_list( $t_builds );
?>

<div>
	<p>
		<i class="icon-key"></i>
		<i class="icon-hashtag"></i>
		Use these
		<a href="https://github.com/mantisbt/mantisbt/blob/master/KEYS.md">PGP keys</a>
		to verify the downloaded files' integrity, using the corresponding signature.
	</p>

<?php
	if( $t_logfile ) {
?>
	<p>
		View the Nightly Builds script's
		<a href="<?php echo $t_logfile['file']; ?>">Log File</a>
		(<?php echo print_timestamp( $t_logfile['time'] ); ?>).
	</p>
<?php
	}
?>
	<p>All times on this page are <?php echo date('T (\U\TCP)') ?>.</p>
</div>

<?php
}

include( "bot.php" );