contrib/rom-o-matic/utils.php

a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync<?php // -*- Mode: PHP; -*-
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Copyright (C) 2009 Marty Connor <mdc@etherboot.org>.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Copyright (C) 2009 Entity Cyber, Inc.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This program is free software; you can redistribute it and/or
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * modify it under the terms of the GNU General Public License as
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * published by the Free Software Foundation; either version 2 of the
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * License, or any later version.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This program is distributed in the hope that it will be useful, but
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * WITHOUT ANY WARRANTY; without even the implied warranty of
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * General Public License for more details.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * You should have received a copy of the GNU General Public License
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * along with this program; if not, write to the Free Software
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// Include table of user-configurable iPXE options
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncrequire_once "flag-table.php";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// Include user-shadowable globals
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncrequire_once "globals.php";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// Allow user to shadow globals
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncif ( is_file ( 'local-config.php" ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    include_once "local-config.php";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync////
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// General utility functions
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync////
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Remove undesirable characters from a given string
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Certain characters have the potential to be used for
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * malicious purposes by web-based attackers.  This routine
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * filters out such characters.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $s supplied string
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return string returned string with unwanted characters
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *                removed
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction cleanstring ( $s )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $len = strlen ( $s );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    if ( $len > 80 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $s = substr ( $s, 0, 80 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $s      = trim ( $s );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $pos    = 0;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $result = "";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    while ( $pos < $len ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $ltr = ord ( ucfirst ( $s[$pos] ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( ( $ltr >= ord ( "A" ) ) && ( $ltr <= ord ( "Z" ) ) ||
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync             ( $ltr >= ord ( "0" ) ) && ( $ltr <= ord ( "9" ) ) ||
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync             ( $ltr == ord ( "." ) ) && ( strlen ( $result ) > 0 ) ||
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync             ( $ltr == ord ( "_" ) ) ||
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync             ( $ltr == ord ( "+" ) ) ||
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync             ( $ltr == ord ( ":" ) ) ||
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync             ( $ltr == ord ( "/" ) ) ||
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync             ( $ltr == ord ( "-" ) ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            $result .= $s[$pos];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $pos++;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return $result;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Return URL of the currently running script, minus the filename
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return string the URL of the currently running script, minus the filename
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction curDirURL ()
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $dir = dirname ( $_SERVER['PHP_SELF"] );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( $dir == "." || $dir == "/" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                $dir = "";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $isHTTPS = ( isset ( $_SERVER["HTTPS"] ) && $_SERVER["HTTPS"] == "on" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $port = ( isset($_SERVER["SERVER_PORT"] ) &&
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                          ( ( !$isHTTPS && $_SERVER["SERVER_PORT"] != "80" ) ||
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                                ( $isHTTPS  && $_SERVER["SERVER_PORT"] != "443" ) ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $port = ( $port ) ? ':" . $_SERVER["SERVER_PORT"] : '";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $dest = ( $isHTTPS ? 'https://" : 'http://" ) .
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                $_SERVER["SERVER_NAME"] . $dir . "/";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        return $dest;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Extract NIC families and associated ROM PCI IDs from the src/bin/NIC file.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * $src_dir must contain the path of the iPXE src directory for this build
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return array[0] array $new_nics
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return array[1] array $roms
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction parse_nic_file ()
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    global $src_dir;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $fd = fopen ( "$src_dir/bin/NIC", "r" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    if ( ! $fd ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        die ( "Missing src/bin/NIC file.  'make bin/NIC'" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $nics = array ();
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $roms = array ();
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $nic = "";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    while ( !feof ( $fd ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $line = trim ( fgets ( $fd, 200 ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $first_eight_chars = substr ( $line, 0, 8 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        settype ( $first_eight_chars, "string" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( strpos ( $first_eight_chars, "family" ) === 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // get pathname of NIC driver
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            #list ( $dummy, $nic ) = split( "[ \t]+", $line );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            list ( $dummy, $nic ) = explode("\t", $line);
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            settype ( $nic, "string" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // extract filename name of driver from pathname
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            $nic = substr ( $nic, strrpos ( $nic, "/" ) + 1,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync               strlen ( $nic ) - strrpos ( $nic, "/" ) + 1 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            $nics[$nic] = $nic;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // For each ISA NIC, there can only be one ROM variant
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            $roms[$nic] = $nic;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        // If the first 8 digits of the line are hex digits
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        // add this rom to the current nic family.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if (    ( strlen ( $first_eight_chars ) == 8 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync             && ( ctype_xdigit ( $first_eight_chars ) )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync             && ( $nic != "" ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            $roms[$first_eight_chars] = $nic;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    fclose ( $fd );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    // put most NICs in nice alpha order for menu
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    ksort ( $nics );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    // add special cases to the top
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $new_nics = array ( "all-drivers" => "ipxe",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                        "undionly" => "undionly",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                        "undi" => "undi",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    foreach ( $nics as $key => $value ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        // skip the undi driver
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( $key != "undi" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            $new_nics[$key] = $value;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return array ( $new_nics, $roms );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync////
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// HTML form utility functions
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync////
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Return html code to create hidden form input fields
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $flag  name of form variable to set
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $value value to give form variable
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return string html code for given hidden form input field
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction hidden ( $flag, $value )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $value = htmlentities ( $value );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return "<input type=\"hidden\" value=\"$value\" name=\"$flag\"></input>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Return html code to create checkbox form input fields
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $flag  name of form variable to set
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $value "on" means box should be checked
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return string html code for given hidden form input field
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction checkbox ( $flag, $value )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return "<input type=\"checkbox\" value=\"on\" name=\"$flag\"" .
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        ($value == "on" ? " checked>" : ">" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Return html code to create text form input fields
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $flag  name of form variable to set
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $value initial contents of field
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $size  size in characters of text box
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return string html code for given text input field
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction textbox ( $flag, $value, $size )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $value = htmlentities ( $value );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return "<input type=\"text\" size=\"$size\" value=\"$value\" name=\"$flag\">";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Return html code to create textarea form fields
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $flag  name of form variable to set
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $value initial contents of textarea
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $rows  height of text area in rows
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $cols  width of text area in columns
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return string html code for given textarea input field
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction textarea ( $flag, $value, $rows, $cols )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $value = htmlentities ( $value );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return "<textarea name=\"$flag\" rows=\"$rows\" cols=\"$cols\">"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            . $value . "</textarea>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Return html code to create select (menu) form fields
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Use array of strings as menu choices
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $flag    name of form variable to set
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param array  $options array of strings representing choices
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $value   value of choice to select in menu
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return string html code for given select (menu) input field
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction menubox ( $name, $options, $value )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $s="<select name=\"$name\">";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    foreach ( $options as $ignore => $option ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( !$value ) $value = $option;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $s .= "<option" . ( $option == $value ? " selected>" : ">" ) .
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            htmlentities ( $option ) . "</option>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return $s . "</select>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Return html code to create select (menu) form fields
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Use indices of array of strings as menu choices rather than
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * the values pointed to by the indicies.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $flag    name of form variable to set
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param array  $options array of strings representing choices
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $value   value of choice to select in menu
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return string html code for given select (menu) input field
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction keys_menubox ( $name, $options, $value )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $s="<select name=\"$name\">";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    foreach ( $options as $option => $ignore ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( !$value ) $value = $option;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $s .= "<option" . ( $option == $value ? " selected>" : ">" ) .
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            htmlentities ( $option ) . "</option>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return $s . "</select>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync////
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// Flag (compile option) handling functions
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync////
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Return default compile options (flags)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Initial compile options are in a global called $flag_table.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Create and return an array containing the ones we want.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return array default compile options (flags)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction default_flags ()
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    global $flag_table;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $flags = array ();
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    foreach ( $flag_table as $key => $props ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $flag  = $props["flag"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $type  = $props["type"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        // Fields like headers have no "value" property
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( isset ( $props["value"] ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            $flags[$flag] = $props["value"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return $flags;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Return combination of default and user compile options (flags)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Initial compile options are in a global called $flag_table.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Compile options may have been changed via form input. We return
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * an array with either the default value of each option or a user
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * supplied value from form input.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return array combined default and user supplied compile options (flags)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction get_flags ()
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    global $flag_table;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $flags = default_flags ();
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    if ( ! isset ( $_POST["use_flags"] ) )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        return $flags;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    foreach ( $flag_table as $key => $props ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $flag = $props["flag"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $type = $props["type"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( isset ( $_POST["$flag"] ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            $flags[$flag] = $_POST["$flag"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            if ( $type == "integer-hex" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                if ( strtolower ( substr ( $flags[$flag], 0, 2 ) ) != "0x" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                    $flags[$flag] = "0x" . $flags[$flag];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        } else if ( $type == "on/off" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // Unchecked checkboxes don't pass any POST value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // so we must check for them specially.  At this
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // point we know that there is no $_POST value set
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // for this option.  If it is a checkbox, this means
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // it is unchecked, so record that in $flags so we
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // can later generate an #undef for this option.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            $flags[$flag] = "off";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return $flags;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Output given value in appropriate format for iPXE config file
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * iPXE config/*.h files use C pre-processor syntax.  Output the given
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * compile option in a format appropriate to its type
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $key   index into $flag_table for given compile option
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $value value we wish to set compile option to
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return string code to set compile option to given value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction pprint_flag ( $key, $value )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    global $flag_table;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    // Determine type of given compile option (flag)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $type = $flag_table[$key]["type"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $s = "";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    if ( $type == "on/off" && $value == "on" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $s = "#define $key";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    } else if ( $type == "on/off" && $value != "on" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $s = "#undef $key";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    } else if ( $type == "string" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $s = ( "#define $key \"" . cleanstring ( $value ) . "\"" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    } else if ($type == "qstring" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $s = ( "#define $key \\\"" . cleanstring ( $value ) . "\\\"" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    } else {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $s = "#define $key " . cleanstring ( $value );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return $s;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Output html code to display all compile options as a table
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param array $flags array of compile options
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return void
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction echo_flags ( $flags )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    global $flag_table;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    echo "<table>\n";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    foreach ( $flag_table as $key => $props ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        // Hide parameters from users that should not be changed.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $hide_from_user = isset ( $props["hide_from_user"] ) ? $props["hide_from_user"] : "no";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $flag = $props["flag"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $type = $props["type"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $value = isset ( $flags[$flag] ) ? $flags[$flag] : '";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( $hide_from_user == "yes" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // Hidden flags cannot not be set by the user.  We use hidden form
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // fields to keep them at their default values.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            if ( $type != "header" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                echo hidden ( $flag, $value );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        } else {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // Flag (iPXE compile option) should be displayed to user
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            if ( $type == "header" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                $label = $props["label"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                echo "<td colspan=2><hr><h3>$label</h3><hr></td>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            } else if ($type == "on/off" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                echo "<td>", checkbox ( $flag, $value ), "</td><td><strong>$flag</strong></td>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            } else {   // don't display checkbox for non-on/off flags
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                echo "<td>&nbsp;</td><td><strong>$flag: </strong>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                if ($type == "choice" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                    $options = $props["options"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                    echo menubox($flag, $options, $value);
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                } else {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                    echo textbox($flag, $value, ($type == "integer" ||
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                                                 $type == "integer-hex"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                                                     ? 7 : 25));
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                echo "</td>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            echo "</tr>\n";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            if ( $type != "header" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                echo "<tr><td>&nbsp;</td>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                echo "<td>\n";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                if ( is_file ( "doc/$flag.html" ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                    include_once "doc/$flag.html";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                echo "\n</td></tr>\n";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    echo "</table>";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Return an array of configuration sections used in all compile options
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * $flag_table, the global list of compile options contains a 'cfgsec'
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * property for each flag we are interested in.  We return a list of
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * all the unique cfgsec options we find in $flag_table.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return array an array of strings representing all unique cfgsec values
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *               found in $flag_table
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction get_flag_cfgsecs ()
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    global $flag_table;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $cfgsecs = array ();
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    foreach ( $flag_table as $key => $props ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( isset ( $props['cfgsec"] ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            $cfgsec = $props["cfgsec"];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            $cfgsecs[$cfgsec] = $cfgsec;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return $cfgsecs;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync////
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// File and directory handling functions
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync////
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Create a copy of a given source directory to a given destination
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Since we are going to modify the source directory, we create a copy
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * of the directory with a unique name in the given destination directory.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * We supply a prefix for the tempnam call to prepend to the random filename
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * it generates.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $src    source directory
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $dst    destination directory
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $prefix string to append to directory created
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return string absolute path to destination directory
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction mktempcopy ( $src, $dst, $prefix )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    if ( $src[0] != "/" ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $src = dirname ( $_SERVER['SCRIPT_FILENAME"] ) . "/" . $src;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    // Create a file in the given destination directory with a unique name
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $dir = tempnam ( $dst, $prefix );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    // Delete the file just created, since it would interfere with the copy we
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    // are about to do.  We only care that the dir name we copy to is unique.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    unlink ( $dir );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    exec ( "/bin/cp -a '$src' '$dir' 2>&1", $cpytxt, $status );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    if ( $status != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        die ( "src directory copy failed!" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return $dir;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Write iPXE config files based on value of given flags
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * iPXE compile options are stored in src/config/*.h .
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * We write out a config file for each set of options.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $config_dir directory to write .h files to
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param array  $flags array of compile options for this build
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return void
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction write_ipxe_config_files ( $config_dir, $flags )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    global $flag_table;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $cfgsecs = get_flag_cfgsecs ();
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    foreach ( $cfgsecs as $cfgsec ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $fname = $config_dir . "/" . $cfgsec . ".h";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $fp = fopen ( $fname, "wb" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( $fp <= 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            die ( "Unable to open $fname file for output!" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $ifdef_secname = "CONFIG_" . strtoupper ( $cfgsec ) . "_H";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        fwrite ( $fp, "#ifndef ${ifdef_secname}\n" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        fwrite ( $fp, "#define ${ifdef_secname}\n" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        fwrite ( $fp, "#include <config/defaults.h>\n" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        foreach ( $flags as $key => $value ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            // When the flag matches this section name, write it out
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            if ( $flag_table[$key]["cfgsec"] == $cfgsec ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync                fwrite ( $fp, pprint_flag ( $key, $value ) . "\n" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        fwrite ( $fp, "#endif /* ${ifdef_secname} */\n" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        fclose ( $fp );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Output a string to a file
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Output a given string to a given pathname. The file will be created if
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * necessary, and the string will replace the file's contents in all cases.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $fname pathname of file to output string to
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param string $ftext text to output to file
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return void
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction write_file_from_string ( $fname, $ftext )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        $fp = fopen ( $fname, "wb" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( ! $fp ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            die ( "Unable to open $fname file for output!" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        fwrite ( $fp, $ftext );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        fclose ( $fp );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Delete a file or recursively delete a directory tree
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param   string   $file_or_dir_name  name of file or directory to delete
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return  bool     Returns TRUE on success, FALSE on failure
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction rm_file_or_dir ( $file_or_dir_name )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    if ( ! file_exists ( $file_or_dir_name ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        return false;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    if ( is_file ( $file_or_dir_name ) || is_link ( $file_or_dir_name ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        return unlink ( $file_or_dir_name );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $dir = dir ( $file_or_dir_name );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    while ( ( $dir_entry = $dir->read () ) !== false ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        if ( $dir_entry == '." || $dir_entry == '..") {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            continue;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        rm_file_or_dir ( $file_or_dir_name . '/" . $dir_entry );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    $dir->close();
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    return rmdir ( $file_or_dir_name );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync////
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// Debugging functions
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync////
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Emit html code to display given array of compile options (flags)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @param array  $flags array of compile options for this build
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return void
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction show_flags ( $flags )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    echo ( "\$flags contains " . count ( $flags ) . " elements:" . "<br>" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    foreach ( $flags as $key => $flag ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        echo ( "\$flags[" . $key . "]=" . "\"$flag\"" . "<br>" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Emit HTML code to display default array of compile options (flags)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * $flag_table contains default compile options and properties.  This
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * routine outputs HTML code to display all properties of $flag_table.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @return void
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncfunction dump_flag_table ()
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync{
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    global $flag_table;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    echo ( "\$flag_table contains " . count ( $flag_table ) . " elements:" . "<br>" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    foreach ( $flag_table as $key => $props ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        print ( "flag_table[" . $key . "] = " . "<br>" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        foreach ( $props as $key2 => $props2 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync            print ( "&nbsp;&nbsp;&nbsp;" . $key2 . " = " . $props2 . "<br>" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync        }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync    }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// Parse src/bin/NIC file
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsynclist ( $nics, $roms ) = parse_nic_file ();
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// For emacs:
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// Local variables:
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync//  c-basic-offset: 4
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync//  c-indent-level: 4
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync//  tab-width: 4
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync// End:
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync?>