# Copyright 2021 the rdiff-backup project
#
# This file is part of rdiff-backup.
#
# rdiff-backup is free software; you can redistribute it and/or modify
# 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.
#
# rdiff-backup 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 rdiff-backup; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA

"""
A built-in rdiff-backup action plug-in to calculate average across multiple
statistics files.
"""

from rdiff_backup import Globals, statistics
from rdiffbackup import actions


class CalculateAction(actions.BaseAction):
    """
    Calculate values (average by default) across multiple statistics files.
    """
    name = "calculate"
    security = "validate"

    @classmethod
    def add_action_subparser(cls, sub_handler):
        subparser = super().add_action_subparser(sub_handler)
        subparser.add_argument(
            "--method", choices=["average"], default="average",
            help="what to calculate from the different session statistics")
        subparser.add_argument(
            "locations", metavar="STATISTIC_FILE", nargs="+",
            help="locations of the session statistic files to calculate from")
        return subparser

    def run(self):
        """
        Print out the calculation of the given statistics files, according
        to calculation method.
        """
        ret_code = super().run()
        if ret_code & Globals.RET_CODE_ERR:
            return ret_code

        statobjs = [
            statistics.StatsObj().read_stats_from_rp(loc)
            for loc in self.connected_locations
        ]
        if self.values.method == "average":  # there is no other right now
            calc_stats = statistics.StatsObj().set_to_average(statobjs)
        print(calc_stats.get_stats_logstring(
            "Average of %d stat files" % len(self.connected_locations)))

        return ret_code


def get_plugin_class():
    return CalculateAction