kallithea.lib.utils2

~~~~~~~~~~~~~~~~~~~~

Some simple helper functions.

Note: all these functions should be independent of Kallithea classes, i.e.

models, controllers, etc.  to prevent import cycles.

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

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

:created_on: Jan 5, 2011

:author: marcink

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

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

"""

import os

import re

import sys

import time

import uuid

import datetime

import urllib

import binascii

import webob

import urlobject

from webhelpers.text import collapse, remove_formatting, strip_tags

from tg.i18n import ugettext as _, ungettext

from kallithea.lib.vcs.utils.lazy import LazyProperty

from kallithea.lib.compat import json

def str2bool(_str):

    """

    returns True/False value from given string, it tries to translate the

    string into boolean

    :param _str: string value to translate into boolean

    :rtype: boolean

    :returns: boolean from given string

    """

    if _str is None:

        return False

    if _str in (True, False):

        return _str

    _str = str(_str).strip().lower()

    else:

        host, port = uri[:cred_pos], uri[cred_pos + 1:]

    return filter(None, [proto, host, port])

def credentials_filter(uri):

    """

    Returns a url with removed credentials

    :param uri:

    """

    uri = uri_filter(uri)

    # check if we have port

    if len(uri) > 2 and uri[2]:

        uri[2] = ':' + uri[2]

    return ''.join(uri)

def get_clone_url(clone_uri_tmpl, prefix_url, repo_name, repo_id, username=None):

    parsed_url = urlobject.URLObject(prefix_url)

    prefix = safe_unicode(urllib.unquote(parsed_url.path.rstrip('/')))

    args = {

        'scheme': parsed_url.scheme,

        'user': safe_unicode(urllib.quote(safe_str(username or ''))),

        'netloc': parsed_url.netloc + prefix,  # like "hostname:port/prefix" (with optional ":port" and "/prefix")

        'prefix': prefix, # undocumented, empty or starting with /

        'repo': repo_name,

        'repoid': str(repo_id),

    }

    url = re.sub('{([^{}]+)}', lambda m: args.get(m.group(1), m.group(0)), clone_uri_tmpl)

    # remove leading @ sign if it's present. Case of empty user

    url_obj = urlobject.URLObject(url)

    if not url_obj.username:

        url_obj = url_obj.with_username(None)

    return safe_unicode(url_obj)

def get_changeset_safe(repo, rev):

    """

    Safe version of get_changeset if this changeset doesn't exists for a

    repo it returns a Dummy one instead

    :param repo:

    :param rev:

    """

    from kallithea.lib.vcs.backends.base import BaseRepository

    from kallithea.lib.vcs.exceptions import RepositoryError

    from kallithea.lib.vcs.backends.base import EmptyChangeset

    if not isinstance(repo, BaseRepository):

        raise Exception('You must pass an Repository '

                            ${_('Show user Gravatars')}

                        </label>

                    </div>

                    ${h.text('gravatar_url', size=80, class_='form-control')}

                    <span class="help-block">${_('''Gravatar URL allows you to use another avatar server application.

                                                        The following variables of the URL will be replaced accordingly.

                                                        {scheme}    'http' or 'https' sent from running Kallithea server,

                                                        {email}     user email,

                                                        {md5email}  md5 hash of the user email (like at gravatar.com),

                                                        {size}      size of the image that is expected from the server application,

                                                        {netloc}    network location/server host of running Kallithea server''')}</span>

                </div>

            </div>

            <div class="form-group">

                <label class="control-label">${_('Clone URL')}:</label>

                <div>

                    ${h.text('clone_uri_tmpl', size=80, class_='form-control')}

                    <span class="help-block">${_('''Schema of clone URL construction eg. '{scheme}://{user}@{netloc}/{repo}'.

                                                    The following variables are available:

                                                    {scheme} 'http' or 'https' sent from running Kallithea server,

                                                    {user}   current user username,

                                                    {netloc} network location/server host of running Kallithea server,

                                                    {repo}   full repository name,

                </div>

            </div>

            <div class="form-group">

                <label class="control-label" for="dashboard_items">${_('Repository page size')}:</label>

                <div>

                    ${h.text('dashboard_items',size=5,class_='form-control')}

                    <span class="help-block">${_('Number of items displayed in the repository pages before pagination is shown.')}</span>

                </div>

            </div>

            <div class="form-group">

                <label class="control-label" for="admin_grid_items">${_('Admin page size')}:</label>

                <div>

                    ${h.text('admin_grid_items',size=5,class_='form-control')}

                    <span class="help-block">${_('Number of items displayed in the admin pages grids before pagination is shown.')}</span>

                </div>

            </div>

            <div class="form-group">

                <label class="control-label">${_('Icons')}:</label>

                <div>

                    <div class="checkbox">

                        <label>