Usage Analytics

# -*- coding: utf-8 -*-
"""Reports which pyNavis tools are used, how often and by whom (opt-in)."""
from pynavis import forms, toast

from namo import paths, ribbon, usage


def plural(count, one, many):
    return '%s %s' % ('{:,}'.format(count), one if count == 1 else many)


def run():
    settings = usage.load_settings()
    rows = usage.read_rows(usage.report_folders(settings))
    if not settings['enabled'] and not rows:
        # Nothing recorded and recording is off: explain exactly what it keeps, then ask.
        if globals().get('__runner__'):
            toast.info('Usage Analytics is off', 'Turn it on from the ribbon; it asks first.')
            return
        agreed = forms.confirm(
            'Usage Analytics records which pyNavis tools are run: the time, your user name, this '
            'computer\'s name, the tool and how long it took. It never records document names, file '
            'paths or model data.\n\nTurn it on?', title='Usage Analytics')
        if agreed:
            usage.save_settings({'enabled': True, 'asked': True})
            toast.success('Usage Analytics is on',
                          'Run a few tools, then click it again for the report. Shift+Click turns it off.')
        return                                      # No: say nothing
    if not rows:
        toast.info('No usage recorded yet', 'Run a few tools, then click Usage Analytics again.')
        return
    summary = usage.aggregate(rows, ribbon.buttons())
    shared = settings.get('shared') and paths.team_available()
    scope = 'Everyone writing to the team folder.' if shared else 'This computer.'
    if not settings['enabled']:
        scope += ' Recording is off now: Shift+Click Usage Analytics to turn it back on.'
    usage.print_report(summary, scope)
    toast.success('Usage report: %s' % plural(summary['runs'], 'run', 'runs'),
                  '%s, %s. Shift+Click for settings and Excel export.'
                  % (plural(summary['tools'], 'tool', 'tools'), plural(summary['users'], 'person', 'people')))


run()

# -*- coding: utf-8 -*-
"""Turns Usage Analytics on or off, picks where it writes, and exports the data to Excel."""
import os

from pynavis import forms, toast

from namo import paths, ribbon, ui, usage, xlsx


def state_toast(saved):
    """One toast for what was saved, honest about a team folder that is not there."""
    title = 'Usage Analytics is %s' % ('on' if saved['enabled'] else 'off')
    if saved['shared'] and not paths.team_available():
        toast.warning(title, 'No team folder is reachable, so records stay on this computer. '
                             'Set the shared folder in Playground Settings.')
    else:
        toast.success(title, 'Records go to %s.' % ('the team folder' if saved['shared'] else 'this computer'))


def export(saved):
    """True when a workbook was written or the failure was reported; False on cancel."""
    rows = usage.read_rows(usage.report_folders(saved))
    if not rows:
        toast.info('Nothing to export yet', 'No usage has been recorded. Turn recording on and run a few tools.')
        return True
    path = forms.save_file(filter='Excel workbooks (*.xlsx)|*.xlsx', default_name='Playground usage.xlsx',
                           title='Export usage')
    if path is None:
        return False
    try:
        xlsx.write_simple(path, usage.xlsx_sheets(usage.aggregate(rows, ribbon.buttons())),
                          title='Playground usage')
    except (IOError, OSError) as error:
        toast.error('Could not write the workbook', 'Close it in Excel, then try again. %s' % error)
    else:
        toast.success('Exported %s run%s' % ('{:,}'.format(len(rows)), '' if len(rows) == 1 else 's'),
                      os.path.basename(path))
    return True


def run():
    settings = usage.load_settings()
    values = ui.form('Usage Analytics', [
        {'kind': 'check', 'key': 'enabled', 'label': 'Record which tools I run', 'default': settings['enabled']},
        {'kind': 'radio', 'key': 'shared', 'label': 'Write the records to',
         'options': [('This computer', False), ('The team folder (one file per person)', True)],
         'default': settings['shared'], 'fallback': None},
        {'kind': 'label', 'text': 'Only the time, user, computer, tool and duration are recorded, never document names.',
         'muted': True},
        {'kind': 'check', 'key': 'export', 'label': 'Export the records to Excel now', 'default': False},
    ], ok='Save')
    if values is None:
        return                                      # cancelled: say nothing
    saved = usage.save_settings({'enabled': values['enabled'], 'shared': values['shared'], 'asked': True})
    # The settings are saved either way; the export, when asked for, reports instead.
    if not (values['export'] and export(saved)):
        state_toast(saved)


if globals().get('__runner__'):
    toast.info('The Usage Analytics settings need the Navisworks window', 'They cannot open under pynavis run.')
else:
    run()

title: Usage\nAnalytics
tooltip: Shows which tools are used, when and by whom, and which are never used. Opt-in, and it never records document names. Shift+Click for settings and Excel export.