functions.php

<?php

# Functions to make strings compatible
function clean_string( $string ) {
    return htmlentities( $string );
}
function sanitize ( $string ) {
    return escapeshellcmd( clean_string( rawurldecode( $string ) ) ) ;
}
function sanitize_datetime ( $dt ) {
    if (preg_match("/^(\d{4}[-\/]\d{2}[-\/]\d{2}|\d{2}[-\/]\d{2}[-\/]\d{4}) \d{1,2}:\d{2}/", $dt)) {
        return date('H:i_Ymd', strtotime($dt));
    }
    else {
        return $dt;
    }
}

# Function to print options for dropdown menus
function print_dropdown_menus($options, $choice, $default) {
    if ( $default != "" ) {
        $option_values = "                <option value=\"\">$default</option>\n";
    }
    else {
        $option_values = "";
    }
    foreach ($options as $option) {
        if ($option == $choice) {
            $selected = "selected=\"selected\"";
        }
        else {
            $selected = "";
        }
        $option_values .= "                <option value=\"$option\" $selected>$option</option>\n";
    }
    return $option_values;
}

# Function to return Graphite server
function graphite_server($environment="default") {
    global $conf;

    if ( !array_key_exists($environment, $conf['graphite_servers']) ) {
        $environment = "default"; #fallback scenario
    }

    $graphite_server = $conf['graphite_servers'][$environment];

    return $graphite_server;
}

# Function to return graph domainname
function get_graph_domainname() {
    global $conf;

    if ($conf['use_random_graph_domainname'])
        return str_replace("//", "//img" . rand(10,80) . ".", $conf['graph_domainname']);

    return $conf['graph_domainname'];
}

# Function to build a Graphite url based on a json report
function build_graphite_series( $config, $host_cluster = "" ) {
    $targets = array();
    $colors = array();
    $pie = 0;
    if ( isset($config['units']) )
        $units = $config['units'];
    else
        $units = "si";

    foreach( $config[ 'series' ] as $item ) {
        $functions = array();
        if ( isset($item['functions']) )
            $functions = $item['functions'];
        else
            $functions[0] = "sumSeries";
        if ( isset($item['hostname']) && isset($item['clustername']) )
            $host_cluster = $item['clustername'] . "." . str_replace(".","_", $item['hostname']);
        $metric = "$host_cluster.${item['metric']}";

        # Work-around for gaps in metrics
        # $metric = "keepLastValue($metric)";

        foreach( $functions as $function ) {
            $metric = "$function($metric)";
        }

        if ( $item['type'] == "stack" )
            $metric = "stacked($metric)";
        if ( $item['type'] == "pie" )
            $pie++;

        if ( isset($config['scale_to_seconds']) )
            $metric = "scaleToSeconds($metric,".$config['scale_to_seconds'].")";

#        $targets[] = "target=". urlencode( "cactiStyle(alias($metric,'${item['label']}'),'${units}')" );
        $targets[] = "target=". urlencode( "alias($metric,'${item['label']}')" );
        $colors[] = $item['color'];
    }

    $output = implode( $targets, '&' );
    $output .= "&colorList=" . implode( $colors, ',' );
    $output .= "&vtitle=" . urlencode( isset($config[ 'vertical_label' ]) ? $config[ 'vertical_label' ] : "" );
    $output .= "&yUnitSystem=" . $units;

    if ( isset($config['graph_max']) )
        $output .= "&max=" . $config['graph_max'];

    if ( $pie > 0 ) {
        $output .= "&graphType=pie";
    }

    return $output;
}

# Functions for printing graph cards
function print_graph($args, $metric_report, $graph_size, $from, $until) {
    global $conf;
    $width  = $conf['graph_sizes'][$graph_size]['width'];
    $height = $conf['graph_sizes'][$graph_size]['height'];

    $graph_html = "
      <div class=\"graph_card\">
        <div class=\"graph_img\">
          <a href=\"?$args&z=$graph_size&from=$from&until=$until\">
            <img width=\"$width\" height=\"$height\" class=\"lazy\" src=\"img/blank.gif\" data-original=\"". get_graph_domainname() . "/graph.php?$args&$metric_report&z=$graph_size&from=$from&until=$until\" />
          </a>
        </div>
        " . show_graph_buttons("$args&$metric_report", $from, $until) . "</div>";
    return $graph_html;
}

function print_zoom_graph($args, $metric_report, $graph_size, $from, $until) {
    global $conf;
    $width  = $conf['graph_sizes'][$graph_size]['width'];
    $height = $conf['graph_sizes'][$graph_size]['height'];

    $graph_html = "
      <div class=\"graph_card\">
        <div class=\"graph_img\">
          <a href=\"graph.php?$args&$metric_report&from=$from&until=$until&z=xlarge\">
            <img width=\"$width\" height=\"$height\" class=\"lazy\" src=\"img/blank.gif\" data-original=\"". get_graph_domainname() . "/graph.php?$args&$metric_report&z=$graph_size&from=$from&until=$until\" />
          </a>
        </div><div class=\"graph_name left\">$metric_report</div>
        " . show_graph_buttons("$args&$metric_report", $from, $until) . "</div>";
    return $graph_html;
}

function show_graph_buttons($args, $from, $until) {
    global $conf;
    $button_html = "<div class=\"graph_buttons right\">
          <a href=\"graph_all_periods.php?$args\">
            <img src=\"img/historical.svg\" class=\"graph_button\" title=\"Show periodic graphs\">
          </a>&nbsp;
          <a href=\"graph.php?$args&from=$from&until=$until&z=xlarge\">
            <img src=\"img/zoom.svg\" class=\"graph_button\" title=\"Show XL graph\">
          </a>&nbsp;";
    if ($conf['graphlot']) {
        $button_html = $button_html . "
          <a href=\"graph.php?$args&from=$from&until=$until&graphlot=true\" target=\"_blank\">
            <img src=\"img/graphlot.svg\" class=\"graph_button\" title=\"Show Graphlot\">
          </a>";
    }
    $button_html = $button_html . "
        </div>
      ";
    return $button_html;
}

function print_period_graph($args, $timeframe) {
    global $conf;
    $graph_size = "large";
    $width  = $conf['graph_sizes']["$graph_size"]['width'];
    $height = $conf['graph_sizes']["$graph_size"]['height'];

    $graph_html = "
      <div class=\"graph_card\">
        <div class=\"graph_img\">
          <a href=\"graph.php?$args&z=xlarge&st=$timeframe+ago\">
            <img width=\"$width\" height=\"$height\" class=\"lazy\" src=\"img/blank.gif\" data-original=\"". get_graph_domainname() . "/graph.php?$args&z=$graph_size&st=$timeframe+ago\" />
          </a>
        </div>
      </div>
      ";
    return $graph_html;
}

# Finds the maximum value from a set of metric graphs
function find_limits($environment, $cluster, $metricname, $start, $end) {
    global $conf;

    $max=0;
    $target = $conf['graphite_prefix'] . "$environment.$cluster.*." . $metricname;
    $raw_data = file_get_contents(graphite_server($environment) . "/render?target=$target&from=$start&until=$end&format=json");
    $data = json_decode($raw_data, TRUE);
    $maxdatapoints = array();
    foreach ( $data as $data_target ) {
        $highestMaxDatapoints = $data_target['datapoints'];
        foreach ( $highestMaxDatapoints as $datapoint ) {
            $maxdatapoints[] = $datapoint[0];
        }
    }
    sort($maxdatapoints);
    $max = round(max($maxdatapoints) * 1.1);
    return $max;
}

# Finds dashboards for a specific environment/cluster
function find_dashboards($environment, $cluster="") {
    global $conf, $dash_config;

    if ( ! isset( $dash_config ) )
        $dash_config = json_decode(file_get_contents($conf['dashboard_config']), TRUE);

    $graph_reports = array();
    foreach ($dash_config['dashboards'] as $dash) {
        if (! preg_match($dash['environments'], $environment) ) {
            continue;
        }
        if ($cluster) {
            if (! preg_match($dash['clusters'], $cluster)){
                continue;
            }
        }
        foreach ($dash['included_reports'] as $dashboard) {
            $graph_reports[] = $dashboard;
        }
    }
    return $graph_reports;
}

# Function to determines if report graphs should be shown in this dashboard
function show_on_dashboard($report_name, $environment, $cluster) {
    global $conf, $dash_config;

    if ( ! isset( $dash_config ) )
        $dash_config = json_decode(file_get_contents($conf['dashboard_config']), TRUE);
    foreach ($dash_config['dashboards'] as $dash) {
        if ( preg_match($dash['environments'], $environment) && preg_match($dash['clusters'], $cluster) ){
            if ( in_array($report_name, $dash['included_reports']) ) {
                return True;
            }
        }
    }
    return False;
}

# Find graphite metrics matching regex
function find_metrics($environment, $search_string, $group_depth=0) {
    global $conf;

    $metrics = array();
    $search_url = graphite_server($environment) . "/metrics/expand/?leavesOnly=1";
    $search_prefix = quotemeta($conf['graphite_prefix'] . "$environment.$search_string");
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    $search_query_array = array();
    $search_query_wildcard = "";
    $i = 0;
    while ($i <= 10) {
        $search_query_wildcard = $search_query_wildcard . ".*";
        $search_query_item = "&query=" . $search_prefix . $search_query_wildcard;
        $search_query_array[] = $search_query_item;
        $i++;
    }
    $search_query = implode("", $search_query_array);
    curl_setopt($ch, CURLOPT_URL, $search_url . $search_query);
    $search_result = json_decode(curl_exec($ch), TRUE);
    $results = $search_result['results'];
    natsort($results);
    foreach ($results as $metric) {
        $metric_string = preg_replace("/^$search_prefix\./", "", $metric);
        $arr = explode('.',trim($metric_string));
        $metric_group = join(".", array_slice($arr, 0, $group_depth));
        if (!isset($metrics[$metric_group]) )
            $metrics[$metric_group] = array();
        $metrics[$metric_group][] = $metric_string;
    }

    curl_close($ch);
    return $metrics;
}

# Find graphite metrics belonging to a specific report
function find_report_metrics($graph_report) {
    global $conf;

    $metrics = array();
    // Generally we only have 1 report specified when using this
    $report_definition_file = $conf['graph_template_dir'] . "/" . $graph_report . ".json";
    if ( is_file($report_definition_file) ) {
        $graph_config = json_decode(file_get_contents($report_definition_file), TRUE);
    }
    else {
        error_log("There is no JSON config file specifying $graph_report.");
        exit(1);
    }
    if ( isset($graph_config['series']) ) {
        foreach ($graph_config['series'] as $serie) {
            $metrics[$graph_config['title'] . " metrics"][] = $serie['metric'];
        }
    }
    return $metrics;
}