.. _general:

=======================

General Kallithea usage

=======================

Repository deletion

-------------------

not physically delete said repository from the filesystem, but instead

renames it in a special way so that it is not possible to push, clone

or access the repository.

There is a special command for cleaning up such archived repositories::

This command scans for archived repositories that are older than

30 days, displays them, and asks if you want to delete them (unless given

forks that are constantly being deleted, it is recommended that you run this

command via crontab.

It is worth noting that even if someone is given administrative access to

Kallithea and deletes a repository, you can easily restore such an action by

renaming the repository directory, removing the ``rm__<date>`` prefix.

File view: follow current branch

--------------------------------

In the file view, left and right arrows allow to jump to the previous and next

revision. Depending on the way revisions were created in the repository, this

could jump to a different branch.  When the checkbox ``Follow current branch``

is checked, these arrows will only jump to revisions on the same branch as the

currently visible revision.  So for example, if someone is viewing files in the

``beta`` branch and marks the `Follow current branch` checkbox, the < and >

arrows will only show revisions on the ``beta`` branch.

Changelog features

------------------

The core feature of a repository's ``changelog`` page is to show the revisions

# -*- coding: utf-8 -*-

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU 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 General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""

This file was forked by the Kallithea project in July 2014 and later moved.

Original author and date, and relevant copyright and licensing information is below:

:created_on: Feb 9, 2013

:author: marcink

:copyright: (c) 2013 RhodeCode GmbH, and others.

:license: GPLv3, see LICENSE.md for more details.

"""

import click

import kallithea.bin.kallithea_cli_base as cli_base

from kallithea.model.meta import Session

from kallithea.model.scm import ScmModel

@cli_base.register_command(config_file_initialize_app=True)

@click.option('--remove-missing', is_flag=True,

        help='Remove missing repositories from the Kallithea database.')

def repo_scan(remove_missing):

    """Scan filesystem for repositories.

    Search the configured repository root for new repositories and add them

    into Kallithea.

    Additionally, report repositories that were previously known to Kallithea

    but are no longer present on the filesystem. If option --remove-missing is

    given, remove the missing repositories from the Kallithea database.

    """

    click.echo('Now scanning root location for new repos ...')

    added, removed = repo2db_mapper(ScmModel().repo_scan(),

                                    remove_obsolete=remove_missing)

    click.echo('Scan completed.')

    if added:

        click.echo('Added: %s' % ', '.join(added))

    if removed:

        click.echo('%s: %s' % ('Removed' if remove_missing else 'Missing',

                          ', '.join(removed)))

    Kallithea is not aware of it. In this case, you should manually run this

    command to update the repository cache.

    If no repositories are specified, the caches of all repositories are

    updated.

    """

    if not repositories:

        repo_list = Repository.query().all()

    else:

        repo_names = [safe_unicode(n.strip()) for n in repositories]

        repo_list = list(Repository.query()

                        .filter(Repository.repo_name.in_(repo_names)))

    for repo in repo_list:

        # update latest revision metadata in database

        repo.update_changeset_cache()

        # invalidate in-memory VCS object cache... will be repopulated on

        # first access

        repo.set_invalidate()

    Session().commit()

    click.echo('Updated database with information about latest change in the following %s repositories:' % (len(repo_list)))

    click.echo('\n'.join(repo.repo_name for repo in repo_list))

    url=__url__,

    install_requires=requirements,

    classifiers=classifiers,

    data_files=data_files,

    packages=packages,

    include_package_data=True,

    message_extractors={'kallithea': [

            ('**.py', 'python', None),

            ('templates/**.mako', 'mako', {'input_encoding': 'utf-8'}),

            ('templates/**.html', 'mako', {'input_encoding': 'utf-8'}),

            ('public/**', 'ignore', None)]},

    zip_safe=False,

    entry_points="""

    [console_scripts]

    kallithea-api =    kallithea.bin.kallithea_api:main

    kallithea-gist =   kallithea.bin.kallithea_gist:main

    kallithea-config = kallithea.bin.kallithea_config:main

    kallithea-cli =    kallithea.bin.kallithea_cli:cli

    [paste.app_factory]

    main = kallithea.config.middleware:make_app

    [gearbox.commands]

    celeryd=kallithea.lib.paster_commands.celeryd:Command

    install-iis=kallithea.lib.paster_commands.install_iis:Command

    make-index=kallithea.lib.paster_commands.make_index:Command

    make-rcext=kallithea.lib.paster_commands.make_rcextensions:Command

    setup-db=kallithea.lib.paster_commands.setup_db:Command

    upgrade-db=kallithea.lib.dbmigrate:UpgradeDb

    """,

)