gnu-social/plugins/YammerImport/lib/yammerprogressform.php

<?php

class YammerProgressForm extends Form
{
    /**
     * ID of the form
     *
     * @return string ID of the form
     */
    function id()
    {
        return 'yammer-progress-form';
    }

    /**
     * class of the form
     *
     * @return string class of the form
     */
    function formClass()
    {
        $classes = array('form_settings');
        $runner = YammerRunner::init();
        if ($runner->lastError()) {
            $classes[] = 'import-error';
        } else if ($runner->state() == 'done') {
            $classes[] = 'import-done';
        } else {
            $classes[] = 'import-progress';
        }
        return implode(' ', $classes);
    }

    /**
     * Action of the form
     *
     * @return string URL of the action
     */
    function action()
    {
        return common_local_url('yammeradminpanel');
    }

    /**
     * Data elements of the form
     *
     * @return void
     */
    function formData()
    {
        $this->out->hidden('subaction', 'progress');

        $runner = YammerRunner::init();

        $error = $runner->lastError();
        $userCount = $runner->countUsers();
        $groupCount = $runner->countGroups();
        $fetchedCount = $runner->countFetchedNotices();
        $savedCount = $runner->countSavedNotices();

        $labels = array(
            'init' => array(
                // TRANS: Field label for a Yammer import initialise step.
                'label' => _m('Initialize'),
                // TRANS: "In progress" description.
                'progress' => _m('No import running'),
                // TRANS: "Complete" description for initialize state.
                'complete' => _m('Initiated Yammer server connection...'),
            ),
            'requesting-auth' => array(
                // TRANS: Field label for a Yammer import connect step.
                'label' => _m('Connect to Yammer'),
                // TRANS: "In progress" description.
                'progress' => _m('Awaiting authorization...'),
                // TRANS: "Complete" description for connect state.
                'complete' => _m('Connected.'),
            ),
            'import-users' => array(
                // TRANS: Field label for a Yammer user import users step.
                'label' => _m('Import user accounts'),
                // TRANS: "In progress" description.
                // TRANS: %d is the number of users to be imported.
                'progress' => sprintf(_m('Importing %d user...',
                                         'Importing %d users...',
                                         $userCount),
                                      $userCount),
                // TRANS: "Complete" description for step.
                // TRANS: %d is the number of users imported.
                'complete' => sprintf(_m('Imported %d user.',
                                         'Imported %d users.',
                                         $userCount),
                                      $userCount),
            ),
            'import-groups' => array(
                // TRANS: Field label for a Yammer group import step.
                'label' => _m('Import user groups'),
                // TRANS: "In progress" description.
                // TRANS: %d is the number of groups to be imported.
                'progress' => sprintf(_m('Importing %d group...',
                                         'Importing %d groups...',
                                         $groupCount),
                                      $groupCount),
                // TRANS: "Complete" description for step.
                // TRANS: %d is the number of groups imported.
                'complete' => sprintf(_m('Imported %d group.',
                                         'Imported %d groups.',
                                         $groupCount),
                                      $groupCount),
            ),
            'fetch-messages' => array(
                // TRANS: Field label for a Yammer import prepare notices step.
                'label' => _m('Prepare public notices for import'),
                // TRANS: "In progress" description.
                // TRANS: %d is the number of notices to be prepared for import.
                'progress' => sprintf(_m('Preparing %d notice...',
                                         'Preparing %d notices...',
                                         $fetchedCount),
                                      $fetchedCount),
                // TRANS: "Complete" description for step.
                // TRANS: %d is the number of notices prepared for import.
                'complete' => sprintf(_m('Prepared %d notice.',
                                         'Prepared %d notices.',
                                         $fetchedCount),
                                      $fetchedCount),
            ),
            'save-messages' => array(
                // TRANS: Field label for a Yammer import notices step.
                'label' => _m('Import public notices'),
                // TRANS: "In progress" description.
                // TRANS: %d is the number of notices to be imported.
                'progress' => sprintf(_m('Importing %d notice...',
                                         'Importing %d notices...',
                                         $savedCount),
                                      $savedCount),
                // TRANS: "Complete" description for step.
                // TRANS: %d is the number of notices imported.
                'complete' => sprintf(_m('Imported %d notice.',
                                         'Imported %d notices.',
                                         $savedCount),
                                      $savedCount),
            ),
            'done' => array(
                // TRANS: Field label for a Yammer import done step.
                'label' => _m('Done'),
                // TRANS: "In progress" description for done step.
                'progress' => sprintf(_m('Import is complete!')),
                // TRANS: "Complete" description for done step.
                'complete' => sprintf(_m('Import is complete!')),
            )
        );
        $steps = array_keys($labels);
        $currentStep = array_search($runner->state(), $steps);

        $classes = array('yammer-import');
        if ($error) {
            $classes[] = 'yammer-error';
        } else {
            $classes[] = 'yammer-running';
        }
        $this->out->elementStart('fieldset', array('class' => implode(' ', $classes)));
        // TRANS: Fieldset legend.
        $this->out->element('legend', array(), _m('Import status'));
        foreach ($steps as $step => $state) {
            if ($state == 'init') {
                // Don't show 'init', it's boring.
                continue;
            }
            if ($step < $currentStep) {
                // This step is done
                $this->progressBar($state,
                                   'complete',
                                   $labels[$state]['label'],
                                   $labels[$state]['complete']);
            } else if ($step == $currentStep) {
                // This step is in progress
                $this->progressBar($state,
                                   'progress',
                                   $labels[$state]['label'],
                                   $labels[$state]['progress'],
                                   $error);
            } else {
                // This step has not yet been done.
                $this->progressBar($state,
                                   'waiting',
                                   $labels[$state]['label'],
                                   // TRANS: Progress bar status.
                                   _m('Waiting...'));
            }
        }
        $this->out->elementEnd('fieldset');
    }

    private function progressBar($state, $class, $label, $status, $error=null)
    {
        // @fixme prettify ;)
        $this->out->elementStart('div', array('class' => "import-step import-step-$state $class"));
        $this->out->element('div', array('class' => 'import-label'), $label);
        $this->out->element('div', array('class' => 'import-status'), $status);
        if ($class == 'progress') {
            if ($state == 'done') {
                // TRANS: Button text for resetting the import state.
                $this->out->submit('abort-import', _m('Reset import state'));
            } else {
                if ($error) {
                    $this->errorBox($error);
                } else {
                    // TRANS: Button text for pausing an import.
                    $this->out->submit('pause-import', _m('Pause import'));
                }
            }
        }
        $this->out->elementEnd('div');
    }

    private function errorBox($msg)
    {
        // TRANS: Error message. %s are the error details.
        $errline = sprintf(_m('Encountered error "%s".'), $msg);
        $this->out->elementStart('fieldset', array('class' => 'import-error'));
        // TRANS: Fieldset legend for a paused import.
        $this->out->element('legend', array(), _m('Paused'));
        $this->out->element('p', array(), $errline);
        // TRANS: Button text for continuing a paused import.
        $this->out->submit('continue-import', _m('Continue'));
        // TRANS: Button text for aborting a paused import.
        $this->out->submit('abort-import', _m('Abort import'));
        $this->out->elementEnd('fieldset');
    }
}