imag/bin/domain/imag-habit/src/main.rs

//
// imag - the personal information management suite for the commandline
// Copyright (C) 2015-2019 Matthias Beyer <mail@beyermatthias.de> and contributors
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; version
// 2.1 of the License.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//

#![forbid(unsafe_code)]

#![deny(
    non_camel_case_types,
    non_snake_case,
    path_statements,
    trivial_numeric_casts,
    unstable_features,
    unused_allocation,
    unused_import_braces,
    unused_imports,
    unused_must_use,
    unused_mut,
    unused_qualifications,
    while_true,
)]

extern crate clap;
#[macro_use] extern crate log;
extern crate toml;
extern crate toml_query;
extern crate kairos;
extern crate chrono;
extern crate prettytable;
#[macro_use] extern crate failure;

extern crate libimaghabit;
extern crate libimagstore;
#[macro_use] extern crate libimagrt;
extern crate libimagerror;
extern crate libimagutil;
extern crate libimaginteraction;

use std::io::Write;
use std::process::exit;

use prettytable::Table;
use prettytable::Cell;
use prettytable::Row;
use failure::Error;

use libimagrt::runtime::Runtime;
use libimagrt::setup::generate_runtime_setup;
use libimagerror::trace::{MapErrTrace, trace_error};
use libimagerror::iter::TraceIterator;
use libimagerror::exit::ExitUnwrap;
use libimagerror::io::ToExitCode;
use libimaghabit::store::HabitStore;
use libimaghabit::habit::builder::HabitBuilder;
use libimaghabit::habit::HabitTemplate;
use libimagstore::store::FileLockEntry;
use libimagstore::store::Store;
use libimagstore::storeid::StoreId;
use libimaginteraction::ask::ask_bool;
use libimagutil::debug_result::DebugResult;

mod ui;

fn main() {
    let version = make_imag_version!();
    let rt = generate_runtime_setup("imag-habit",
                                    &version,
                                    "Habit tracking tool",
                                    ui::build_ui);


    let _ = rt
        .cli()
        .subcommand_name()
        .map(|name| {
            debug!("Call {}", name);
            match name {
                "create" => create(&rt),
                "delete" => delete(&rt),
                "list"   => list(&rt),
                "today"  => today(&rt, false),
                "status" => today(&rt, true),
                "show"   => show(&rt),
                "done"   => done(&rt),
                other    => {
                    debug!("Unknown command");
                    let _ = rt.handle_unknown_subcommand("imag-habit", other, rt.cli())
                        .map_err_trace_exit_unwrap()
                        .code()
                        .map(::std::process::exit);
                },
            }
        })
        .unwrap_or_else(|| today(&rt, true));
}

fn create(rt: &Runtime) {
    use kairos::parser::parse as kairos_parse;
    use kairos::parser::Parsed;
    let scmd  = rt.cli().subcommand_matches("create").unwrap();                      // safe by call from main()
    let name  = scmd.value_of("create-name").map(String::from).unwrap();             // safe by clap
    let recu  = scmd.value_of("create-date-recurr-spec").map(String::from).unwrap(); // safe by clap
    let comm  = scmd.value_of("create-comment").map(String::from).unwrap();          // safe by clap
    let date  = scmd.value_of("create-date").unwrap();                               // safe by clap

    let parsedate = |d, pname| match kairos_parse(d).map_err_trace_exit_unwrap() {
        Parsed::TimeType(tt) => tt.calculate()
            .map_dbg(|y| format!("TimeType yielded: '{:?}'", y))
            .map_err_trace_exit_unwrap()
            .get_moment()
            .ok_or_else(|| {
                error!("Error: '{}' parameter does not yield a point in time", pname);
                exit(1)
            })
            .unwrap() // safe by above
            .date(),
        _ => {
            error!("Error: '{}' parameter does not yield a point in time", pname);
            exit(1);
        },
    };

    debug!("Building habit: name = {name}, basedate = {date}, recurr = {recu}, comment = {comm}",
           name = name,
           date = date,
           recu = recu,
           comm = comm);

    let hb = HabitBuilder::default()
        .with_name(name)
        .with_basedate(parsedate(date, "date"))
        .with_recurspec(recu)
        .with_comment(comm);

    let hb = if let Some(until) = scmd.value_of("create-until") {
        hb.with_until(parsedate(until, "until"))
    } else {
        hb
    };

    debug!("Builder = {:?}", hb);

    let fle = hb.build(rt.store()).map_err_trace_exit_unwrap();
    let _   = rt.report_touched(fle.get_location()).unwrap_or_exit();
}

fn delete(rt: &Runtime) {
    use libimaghabit::instance::HabitInstance;

    let scmd = rt.cli().subcommand_matches("delete").unwrap();          // safe by call from main()
    let name = scmd.value_of("delete-name").map(String::from).unwrap(); // safe by clap
    let yes  = scmd.is_present("delete-yes");
    let delete_instances = scmd.is_present("delete-instances");

    let mut input = rt.stdin().unwrap_or_else(|| {
        error!("No input stream. Cannot ask for permission");
        exit(1);
    });

    let mut output = rt.stdout();

    let _ = rt
        .store()
        .all_habit_templates()
        .map_err_trace_exit_unwrap()
        .trace_unwrap_exit()
        .map(|sid| (sid.clone(), rt.store().get(sid).map_err_trace_exit_unwrap())) // get the FileLockEntry
        .filter(|&(_, ref habit)| match habit { // filter for name of habit == name we look for
            &Some(ref h) => h.habit_name().map_err_trace_exit_unwrap() == name,
            &None => false,
        })
        .filter_map(|(a, o)| o.map(|x| (a, x))) // map: (a, Option<b>) -> Option<(a, b)> -> (a, b)
        .map(|(sid, fle)| {
            if delete_instances {

                // if this does not succeed, we did something terribly wrong
                let t_name = fle.habit_name().map_err_trace_exit_unwrap();
                assert_eq!(t_name, name);

                let get_instance          =  |iid| rt.store().get(iid).map_err_trace_exit_unwrap();
                let has_template_name     =  |i: &FileLockEntry| t_name ==  i.get_template_name().map_err_trace_exit_unwrap();
                let instance_location     =  |i: FileLockEntry| i.get_location().clone();
                let delete_instance_by_id =  |id| {
                    let do_delete = |id| rt.store().delete(id).map_err_trace_exit_unwrap();
                    if !yes {
                        let q = format!("Really delete {}", id);
                        if ask_bool(&q, Some(false), &mut input, &mut output)
                            .map_err_trace_exit_unwrap()
                        {
                            let _ = do_delete(id);
                        }
                    } else {
                        let _ = do_delete(id);
                    }
                };

                let _ = fle
                    .linked_instances()
                    .map_err_trace_exit_unwrap()
                    .trace_unwrap_exit()
                    .filter_map(get_instance)
                    .filter(has_template_name)
                    .map(instance_location)
                    .map(delete_instance_by_id)
                    .collect::<Vec<_>>();
            }

            drop(fle);

            let do_delete_template = |sid| rt.store().delete(sid).map_err_trace_exit_unwrap();
            if !yes {
                let q = format!("Really delete template {}", sid);
                if ask_bool(&q, Some(false), &mut input, &mut output)
                        .map_err_trace_exit_unwrap()
                {
                    let _ = do_delete_template(sid);
                }
            } else {
                let _ = do_delete_template(sid);
            }
        })
        .collect::<Vec<_>>();

    info!("Done");
}

// Almost the same as `list()` but with other lister functions and an additional filter for only
// listing entries which are due today.
//
// if `future` is false, the `rt.cli()` will be checked or a subcommand "today" and the related
// future flag. If it is true, the check will not be performed and it is assumed that `--future`
// was passed.
fn today(rt: &Runtime, future: bool) {
    use failure::ResultExt;

    let (future, show_done) = {
        if !future {
            let scmd = rt.cli().subcommand_matches("today").unwrap();
            let futu = scmd.is_present("today-show-future");
            let done = scmd.is_present("today-done");
            (futu, done)
        } else {
            if let Some(status) = rt.cli().subcommand_matches("status") {
                (true, status.is_present("status-done"))
            } else {
                (true, false)
            }
        }
    };
    let today = ::chrono::offset::Local::today().naive_local();

    let relevant : Vec<_> = { // scope, to have variable non-mutable in outer scope
        let mut relevant : Vec<_> = rt
            .store()
            .all_habit_templates()
            .map_err_trace_exit_unwrap()
            .trace_unwrap_exit()
            .filter_map(|id| match rt.store().get(id.clone()) {
                Ok(Some(h)) => Some(h),
                Ok(None) => {
                    error!("No habit found for {:?}", id);
                    None
                },
                Err(e) => {
                    trace_error(&e);
                    None
                },
            })
            .filter(|h| {
                let due = h.next_instance_date().map_err_trace_exit_unwrap();
                // today or in future
                debug!("Checking {due:?} == {today:?} or (future = {fut} && {due:?} > {today:?}",
                       due = due, today = today, fut = future);
                due.map(|d| d == today || (future && d > today)).unwrap_or(false)
            })
            .collect();

        // unwrap is safe because we filtered above
        relevant.sort_by_key(|h| h.next_instance_date().map_err_trace_exit_unwrap().unwrap());
        relevant
    };

    let any_today_relevant = show_done || relevant
        .iter()
        .filter(|h| {
            let due = h.next_instance_date().map_err_trace_exit_unwrap();
            debug!("Checking: {:?} == {:?}", due, today);
            due.map(|d| d == today).unwrap_or(false) // relevant today
        })
        .count() != 0;

    debug!("Any today relevant = {}", any_today_relevant);
    debug!("relevant = {:?}", relevant);

    if !any_today_relevant {
        let n = rt
            .cli()
            .subcommand_matches("today")
            .and_then(|am| {
                am.value_of("today-show-next-n")
                    .map(|x| {
                        x.parse::<usize>()
                            .context(format_err!("Cannot parse String '{}' to integer", x))
                            .map_err(Error::from)
                            .map_err_trace_exit_unwrap()
                    })
            }).unwrap_or(5);

        info!("No Habits due today.");
        info!("Upcoming:");
        // list `n` which are relevant in the future.
        relevant.iter().take(n).for_each(|element| {
            let date = element.next_instance_date().map_err_trace_exit_unwrap();
            let name = element.habit_name().map_err_trace_exit_unwrap();

            if let Some(date) = date {
                let is_done = element
                    .instance_exists_for_date(&date)
                    .map_err_trace_exit_unwrap();

                if show_done || !is_done {
                    info!(" * {date}: {name}", date = date, name = name);
                }
            }
        });
    } else {
        fn lister_fn(h: &FileLockEntry) -> Vec<String> {
            debug!("Listing: {:?}", h);
            let name     = h.habit_name().map_err_trace_exit_unwrap();
            let basedate = h.habit_basedate().map_err_trace_exit_unwrap();
            let recur    = h.habit_recur_spec().map_err_trace_exit_unwrap();
            let due      = h.next_instance_date().map_err_trace_exit_unwrap()
                .map(date_to_string_helper)
                .unwrap_or_else(|| String::from("<finished>"));
            let comm     = h.habit_comment().map_err_trace_exit_unwrap();

            let v = vec![name, basedate, recur, due, comm];
            debug!(" -> {:?}", v);
            v
        }

        let header = ["#", "Name", "Basedate", "Recurr", "Next Due", "Comment"]
            .iter()
            .map(|s| Cell::new(s))
            .collect::<Vec<Cell>>();

        let mut table = Table::new();
        table.set_titles(Row::new(header));

        let mut empty = true;
        relevant
            .into_iter()
            .filter(|habit| show_done || {
                let instance_exists = habit
                    .next_instance_date()
                    .map_err_trace_exit_unwrap()
                    .map(|date|  {
                        let instance_exists = habit
                            .instance_exists_for_date(&date)
                            .map_err_trace_exit_unwrap();

                        debug!("instance exists for {:?} for {:?} = {:?}",
                               habit.get_location().local_display_string(),
                               date,
                               instance_exists);

                        instance_exists
                    })
                    .unwrap_or(false);

                !instance_exists
            })
            .enumerate()
            .for_each(|(i, e)| {
                let mut v = vec![format!("{}", i)];
                let mut list = lister_fn(&e);

                {
                    let _ = rt
                        .report_touched(e.get_location())
                        .unwrap_or_exit();
                }

                v.append(&mut list);
                table.add_row(v.iter().map(|s| Cell::new(s)).collect());
                empty = false;
            });

        if !empty {
            let _ = table.print(&mut rt.stdout()).to_exit_code().unwrap_or_exit();
        }
    }
}

fn list(rt: &Runtime) {
    fn lister_fn(h: &FileLockEntry) -> Vec<String> {
        debug!("Listing: {:?}", h);
        let name     = h.habit_name().map_err_trace_exit_unwrap();
        let basedate = h.habit_basedate().map_err_trace_exit_unwrap();
        let recur    = h.habit_recur_spec().map_err_trace_exit_unwrap();
        let comm     = h.habit_comment().map_err_trace_exit_unwrap();
        let (due, done) = if let Some(date) = h.next_instance_date().map_err_trace_exit_unwrap() {
            let done     = h.instance_exists_for_date(&date)
                .map(|b| if b { "x" } else { "" })
                .map(String::from)
                .map_err_trace_exit_unwrap();
            (date_to_string_helper(date), done)
        } else {
            // "finished" as in "the habit is closed"
            (String::from("<finished>"), String::from(""))
        };

        let v = vec![name, basedate, recur, comm, due, done];
        debug!(" -> {:?}", v);
        v
    }

    let header = ["#", "Name", "Basedate", "Recurr", "Comment", "Next Due", "Done"]
        .iter()
        .map(|s| Cell::new(s))
        .collect::<Vec<Cell>>();

    let mut empty = true;
    let mut table = Table::new();
    table.set_titles(Row::new(header));

    let _ = rt
        .store()
        .all_habit_templates()
        .map_err_trace_exit_unwrap()
        .trace_unwrap_exit()
        .filter_map(|id| match rt.store().get(id.clone()) {
            Ok(Some(h)) => Some(h),
            Ok(None) => {
                error!("No habit found for {:?}", id);
                None
            },
            Err(e) => {
                trace_error(&e);
                None
            },
        })
        .enumerate()
        .for_each(|(i, e)| {
            let mut v = vec![format!("{}", i)];
            let mut list = lister_fn(&e);

            {
                let _ = rt.report_touched(e.get_location()).unwrap_or_exit();
            }

            v.append(&mut list);
            table.add_row(v.iter().map(|s| Cell::new(s)).collect());
            empty = false;
        });

    if !empty {
        let _ = table.print(&mut rt.stdout()).to_exit_code().unwrap_or_exit();
    }
}

fn show(rt: &Runtime) {
    let scmd = rt.cli().subcommand_matches("show").unwrap();          // safe by call from main()
    let name = scmd
        .value_of("show-name")
        .map(String::from)
        .unwrap(); // safe by clap

    fn instance_lister_fn(rt: &Runtime, i: &FileLockEntry) -> Vec<String> {
        use libimagutil::date::date_to_string;
        use libimaghabit::instance::HabitInstance;

        let date = date_to_string(&i.get_date().map_err_trace_exit_unwrap());
        let comm = i.get_comment(rt.store()).map_err_trace_exit_unwrap();

        vec![date, comm]
    }

    let header = ["#", "Date", "Comment"]
        .iter()
        .map(|s| Cell::new(s))
        .collect::<Vec<Cell>>();

    let mut table = Table::new();
    table.set_titles(Row::new(header));

    let _ = rt
        .store()
        .all_habit_templates()
        .map_err_trace_exit_unwrap()
        .trace_unwrap_exit()
        .filter_map(|id| get_from_store(rt.store(), id))
        .filter(|h| h.habit_name().map(|n| name == n).map_err_trace_exit_unwrap())
        .enumerate()
        .map(|(i, habit)| {
            let name     = habit.habit_name().map_err_trace_exit_unwrap();
            let basedate = habit.habit_basedate().map_err_trace_exit_unwrap();
            let recur    = habit.habit_recur_spec().map_err_trace_exit_unwrap();
            let comm     = habit.habit_comment().map_err_trace_exit_unwrap();

            let _ = writeln!(rt.stdout(),
                     "{i} - {name}\nBase      : {b},\nRecurrence: {r}\nComment   : {c}\n",
                     i    = i,
                     name = name,
                     b    = basedate,
                     r    = recur,
                     c    = comm)
                .to_exit_code()
                .unwrap_or_exit();

            let mut empty = true;
            let iter = habit
                .linked_instances()
                .map_err_trace_exit_unwrap()
                .trace_unwrap_exit()
                .filter_map(|instance_id| {
                    debug!("Getting: {:?}", instance_id);
                    rt.store().get(instance_id).map_err_trace_exit_unwrap()
                })
                .enumerate();

            // We need to drop here because we iterate over instances and in the
            // instance_lister_fn() we call instance.get_comment(), which internally tries to
            // Store::get() the template object.
            // This would fail because the template is already borrowed.
            drop(habit);

            iter.for_each(|(i, e)| {
                    let mut v = vec![format!("{}", i)];
                    let mut instances = instance_lister_fn(&rt, &e);

                    {
                        let _ = rt.report_touched(e.get_location()).unwrap_or_exit();
                    }

                    v.append(&mut instances);
                    table.add_row(v.iter().map(|s| Cell::new(s)).collect());
                    empty = false;
                });

            if !empty {
                let _ = table.print(&mut rt.stdout()).to_exit_code().unwrap_or_exit();
            }
        })
        .collect::<Vec<_>>();
}

fn done(rt: &Runtime) {
    let scmd = rt.cli().subcommand_matches("done").unwrap(); // safe by call from main()
    let names : Vec<_> = scmd.values_of("done-name").unwrap().map(String::from).collect();

    let today = ::chrono::offset::Local::today().naive_local();

    let relevant : Vec<_> = { // scope, to have variable non-mutable in outer scope
        let mut relevant : Vec<_> = rt
            .store()
            .all_habit_templates()
            .map_err_trace_exit_unwrap()
            .trace_unwrap_exit()
            .filter_map(|id| get_from_store(rt.store(), id))
            .filter(|h| {
                let due = h.next_instance_date().map_err_trace_exit_unwrap();
                due.map(|d| (d == today || d < today) || scmd.is_present("allow-future"))
                    .unwrap_or(false)
            })
            .filter(|h| {
                names.contains(&h.habit_name().map_err_trace_exit_unwrap())
            })
            .collect();

        // unwrap is safe because we filtered above
        relevant.sort_by_key(|h| h.next_instance_date().map_err_trace_exit_unwrap().unwrap());
        relevant
    };

    for mut r in relevant {
        let next_instance_name = r.habit_name().map_err_trace_exit_unwrap();
        let next_instance_date = r.next_instance_date().map_err_trace_exit_unwrap();
        if let Some(next) = next_instance_date {
            debug!("Creating new instance on {:?}", next);
            r.create_instance_with_date(rt.store(), &next)
                .map_err_trace_exit_unwrap();

            info!("Done on {date}: {name}",
                  date = libimagutil::date::date_to_string(&next),
                  name = next_instance_name);
        } else {
            info!("Ignoring: {}, because there is no due date (the habit is finised)",
                next_instance_name);
        }

        {
            let _ = rt.report_touched(r.get_location()).unwrap_or_exit();
        }

    }
    info!("Done.");
}

/// Helper function for `Iterator::filter_map()`ing `all_habit_templates()` and `Store::get` them.
fn get_from_store<'a>(store: &'a Store, id: StoreId) -> Option<FileLockEntry<'a>> {
    match store.get(id.clone()) {
        Ok(Some(h)) => Some(h),
        Ok(None) => {
            error!("No habit found for {:?}", id);
            None
        },
        Err(e) => {
            trace_error(&e);
            None
        },
    }
}

fn date_to_string_helper(d: chrono::NaiveDate) -> String {
    libimagutil::date::date_to_string(&d)
}