housesprinkler_time.c

/* housesprinkler - A simple home web server for sprinkler control
 *
 * Copyright 2023, Pascal Martin
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301, USA.
 *
 *
 * housesprinkler_time.c - Time operations for the sprinkler controller.
 *
 * SYNOPSYS:
 *
 * const char *housesprinkler_time_period_printable (int period);
 *
 *    This function generates a string showing the time period in a user
 *    friendly way (days and hours, or hours and minutes, or minutes and
 *    seconds).
 *
 *    The returned string is a static location: every call erases the previous
 *    result.
 *
 * const char *housesprinkler_time_delta_printable (time_t start, time_t end);
 *
 *    This function calls housesprinkler_time_period_printable() after
 *    calculating the time period for you.
 */

#include <string.h>
#include <stdlib.h>

#include <echttp.h>
#include <echttp_json.h>

#include "houselog.h"

#include "housesprinkler.h"
#include "housesprinkler_time.h"

#define DEBUG if (sprinkler_isdebug()) printf


static const char *housesprinkler_time_print (int h, const char *hlabel,
                                              int l, const char *llabel) {
    static char Printable[128];
    if (l > 0) {
        snprintf (Printable, sizeof(Printable),
                  "%d %s%s, %d %s%s", h, hlabel, (h>1)?"S":"",
                                      l, llabel, (l>1)?"S":"");
    } else {
        snprintf (Printable, sizeof(Printable),
                  "%d %s%s", h, hlabel, (h>1)?"S":"");
    }
    return Printable;
}

const char *housesprinkler_time_period_printable (int period) {
    if (period <= 0) return "NOW";
    if (period > 86400) {
        return housesprinkler_time_print (period / 86400, "DAY", (period % 86400) / 3600, "HOUR");
    } else if (period > 3600) {
        return housesprinkler_time_print (period / 3600, "HOUR", (period % 3600) / 60, "MINUTE");
    } else if (period > 60) {
        return housesprinkler_time_print (period / 60, "MINUTE", period % 60, "SECOND");
    }
    return housesprinkler_time_print (period, "SECOND", 0, "");
}

const char *housesprinkler_time_delta_printable (time_t start, time_t end) {
    return housesprinkler_time_period_printable ((int)(end - start));
}