We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

backupaccount.php 6.5 KB
Newer Older
1 2 3 4 5 6
<?php
/**
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2010, StatusNet, Inc.
 *
 * Download a backup of your own account to the browser
7
 *
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
 * PHP version 5
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Account
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    // This check helps protect against security problems;
    // your code file can't be executed directly from the web.
    exit(1);
}

/**
 * Download a backup of your own account to the browser
 *
 * We go through some hoops to make this only respond to POST, since
 * it's kind of expensive and there's probably some downside to having
 * your account in all kinds of search engines.
 *
 * @category  Account
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */
class BackupaccountAction extends Action
{
    /**
     * Returns the title of the page
55
     *
56 57 58 59
     * @return string page title
     */
    function title()
    {
60
        // TRANS: Title for backup account page.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
        return _("Backup account");
    }

    /**
     * For initializing members of the class.
     *
     * @param array $argarray misc. arguments
     *
     * @return boolean true
     */
    function prepare($argarray)
    {
        parent::prepare($argarray);

        $cur = common_current_user();

        if (empty($cur)) {
78
            // TRANS: Client exception thrown when trying to backup an account while not logged in.
79 80 81 82
            throw new ClientException(_('Only logged-in users can backup their account.'), 403);
        }

        if (!$cur->hasRight(Right::BACKUPACCOUNT)) {
83
            // TRANS: Client exception thrown when trying to backup an account without having backup rights.
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
            throw new ClientException(_('You may not backup your account.'), 403);
        }

        return true;
    }

    /**
     * Handler method
     *
     * @param array $argarray is ignored since it's now passed in in prepare()
     *
     * @return void
     */
    function handle($argarray=null)
    {
Brion Vibber's avatar
Brion Vibber committed
99
        parent::handle($argarray);
100 101 102 103 104 105 106 107 108 109 110

        if ($this->isPost()) {
            $this->sendFeed();
        } else {
            $this->showPage();
        }
        return;
    }

    /**
     * Send a feed of the user's activities to the browser
111
     *
112 113 114 115 116 117 118 119
     * Uses the UserActivityStream class; may take a long time!
     *
     * @return void
     */

    function sendFeed()
    {
        $cur = common_current_user();
120

121 122 123 124 125 126 127 128 129 130 131 132 133
        $stream = new UserActivityStream($cur);

        header('Content-Disposition: attachment; filename='.$cur->nickname.'.atom');
        header('Content-Type: application/atom+xml; charset=utf-8');

        $this->raw($stream->getString());
    }

    /**
     * Show a little form so that the person can request a backup.
     *
     * @return void
     */
134

135 136 137 138 139
    function showContent()
    {
        $form = new BackupAccountForm($this);
        $form->show();
    }
140

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
    /**
     * Return true if read only.
     *
     * MAY override
     *
     * @param array $args other arguments
     *
     * @return boolean is read only action?
     */
    function isReadOnly($args)
    {
        return false;
    }

    /**
     * Return last modified, if applicable.
     *
     * MAY override
     *
     * @return string last modified http header
     */
    function lastModified()
    {
        // For comparison with If-Last-Modified
        // If not applicable, return null
        return null;
    }

    /**
     * Return etag, if applicable.
     *
     * MAY override
     *
     * @return string etag http header
     */
    function etag()
    {
        return null;
    }
}

/**
 * A form for backing up the account.
 *
 * @category  Account
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */
class BackupAccountForm extends Form
{
    /**
     * Class of the form.
     *
     * @return string the form's class
     */
    function formClass()
    {
        return 'form_profile_backup';
    }

    /**
     * URL the form posts to
     *
     * @return string the form's action URL
     */
    function action()
    {
        return common_local_url('backupaccount');
    }

    /**
     * Output form data
216
     *
217 218 219 220 221 222 223
     * Really, just instructions for doing a backup.
     *
     * @return void
     */
    function formData()
    {
        $msg =
224
            // TRANS: Information displayed on the backup account page.
225 226
            _('You can backup your account data in '.
              '<a href="http://activitystrea.ms/">Activity Streams</a> '.
227
              'format. This is an experimental feature and provides an '.
228 229 230 231 232 233 234 235 236 237 238
              'incomplete backup; private account '.
              'information like email and IM addresses is not backed up. '.
              'Additionally, uploaded files and direct messages are not '.
              'backed up.');
        $this->out->elementStart('p');
        $this->out->raw($msg);
        $this->out->elementEnd('p');
    }

    /**
     * Buttons for the form
239
     *
240 241 242 243 244 245 246
     * In this case, a single submit button
     *
     * @return void
     */
    function formActions()
    {
        $this->out->submit('submit',
247
                           // TRANS: Submit button to backup an account on the backup account page.
248 249 250
                           _m('BUTTON', 'Backup'),
                           'submit',
                           null,
251
                           // TRANS: Title for submit button to backup an account on the backup account page.
252 253 254
                           _('Backup your account'));
    }
}