.. _general:

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

General RhodeCode usage

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

Repository deleting

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

Currently when admin/owner deletes a repository, RhodeCode does not physically

delete a repository from filesystem, it renames it in a special way so it's

not possible to push,clone or access repository. It's worth a notice that,

even if someone will be given administrative access to RhodeCode and will

delete a repository You can easy restore such action by restoring `rm__<date>`

from the repository name, and internal repository storage (.hg/.git). There

is also a special command for cleaning such archived repos::

    paster cleanup-repos --older-than=30d production.ini

This command will scan for archived repositories that are older than 30d,

display them and ask if you want to delete them (there's a --dont-ask flag also)

If you host big amount of repositories with forks that are constantly deleted

it's recommended that you run such command via crontab.

Follow current branch in file view

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

In file view when this checkbox is checked the << and >> arrows will jump

to changesets within the same branch currently viewing. So for example

if someone is viewing files at 'beta' branch and marks `follow current branch`

checkbox the << and >> buttons will only show him revisions for 'beta' branch

Compare view from changelog

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

Checkboxes in compare view allow users to view combined compare view. You can

only show the range between the first and last checkbox (no cherry pick).

Clicking more than one checkbox will activate a link in top saying

compare view. In this view also it's possible to switch to combined compare.

Compare view is also available from the journal on pushes having more than

one changeset

Non changeable repository urls

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

Due to complicated nature of repository grouping, often urls of repositories

can change.

example::

  #before

  http://server.com/repo_name

  # after insertion to test_group group the url will be

  http://server.com/test_group/repo_name

This can be an issue for build systems and any other hardcoded scripts, moving

repository to a group leads to a need for changing external systems. To

overcome this RhodeCode introduces a non changable replacement url. It's

simply an repository ID prefixed with `_` above urls are also accessible as::

  http://server.com/_<ID>

Since ID are always the same moving the repository will not affect such url.

the _<ID> syntax can be used anywhere in the system so urls with repo_name

for changelogs, files and other can be exchanged with _<ID> syntax.

Mailing

-------

When administrator will fill up the mailing settings in .ini files

RhodeCode will send mails on user registration, or when RhodeCode errors occur

on errors the mails will have a detailed traceback of error.

Mails are also sent for code comments. If someone comments on a changeset

mail is sent to all participants, the person who commited the changeset

(if present in RhodeCode), and to all people mentioned with @mention system.

Trending source files

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

Trending source files are calculated based on pre defined dict of known

        <title>${self.title()}</title>

        <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />

        <meta name="robots" content="index, nofollow"/>

        <link rel="icon" href="${h.url('/images/icons/database_gear.png')}" type="image/png" />

        ## CSS ###

        <%def name="css()">

            <link rel="stylesheet" type="text/css" href="${h.url('/css/style.css', ver=c.rhodecode_version)}" media="screen"/>

            <link rel="stylesheet" type="text/css" href="${h.url('/css/pygments.css', ver=c.rhodecode_version)}"/>

            <link rel="stylesheet" type="text/css" href="${h.url('/css/contextbar.css', ver=c.rhodecode_version)}"/>

            ## EXTRA FOR CSS

            ${self.css_extra()}

        </%def>

        <%def name="css_extra()">

        </%def>

        ${self.css()}

        %if c.ga_code:

        <!-- Analytics -->

        <script type="text/javascript">

            var _gaq = _gaq || [];

            _gaq.push(['_setAccount', '${c.ga_code}']);

            _gaq.push(['_trackPageview']);

            (function() {

                var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

                ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';

                var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);

                })();

        </script>

        %endif

        ## JAVASCRIPT ##

        <%def name="js()">

            <script type="text/javascript">

            //JS translations map

            var TRANSLATION_MAP = {

                'Add another comment':'${_("Add another comment")}',

                'Stop following this repository':"${_('Stop following this repository')}",

                'Start following this repository':"${_('Start following this repository')}",

                'Group':"${_('Group')}",

                'members':"${_('members')}",

                'Loading ...':"${_('Loading ...')}",

                'Search truncated': "${_('Search truncated')}",

                'No matching files': "${_('No matching files')}",

                'Open new pull request': "${_('Open new pull request')}",

                'Open new pull request for selected changesets':  "${_('Open new pull request for selected changesets')}",

                'Selection link': "${_('Selection link')}",

                'Collapse diff': "${_('Collapse diff')}",

                'Expand diff': "${_('Expand diff')}"

            };

            var _TM = TRANSLATION_MAP;

            var TOGGLE_FOLLOW_URL  = "${h.url('toggle_following')}";

            </script>

            <script type="text/javascript" src="${h.url('/js/yui.2.9.js', ver=c.rhodecode_version)}"></script>

            <!--[if lt IE 9]>

               <script language="javascript" type="text/javascript" src="${h.url('/js/excanvas.min.js')}"></script>

            <![endif]-->

            <script type="text/javascript" src="${h.url('/js/yui.flot.js', ver=c.rhodecode_version)}"></script>

            <script type="text/javascript" src="${h.url('/js/native.history.js', ver=c.rhodecode_version)}"></script>

            <script type="text/javascript" src="${h.url('/js/pyroutes_map.js', ver=c.rhodecode_version)}"></script>

            <script type="text/javascript" src="${h.url('/js/rhodecode.js', ver=c.rhodecode_version)}"></script>

           ## EXTRA FOR JS

           ${self.js_extra()}

            <script type="text/javascript">

            (function(window,undefined){

                // Prepare

                var History = window.History; // Note: We are using a capital H instead of a lower h

                if ( !History.enabled ) {

                     // History.js is disabled for this browser.

                     // This is because we can optionally choose to support HTML4 browsers or not.

                    return false;

                }

            })(window);

            YUE.onDOMReady(function(){

              tooltip_activate();

              show_more_event();

              show_changeset_tooltip();

              // routes registration

              pyroutes.register('toggle_following', "${h.url('toggle_following')}");

              pyroutes.register('changeset_info', "${h.url('changeset_info', repo_name='%(repo_name)s', revision='%(revision)s')}", ['repo_name', 'revision']);

              pyroutes.register('repo_size', "${h.url('repo_size', repo_name='%(repo_name)s')}", ['repo_name']);

           })

            </script>

        </%def>

        <%def name="js_extra()"></%def>

        ${self.js()}

        <%def name="head_extra()"></%def>

        ${self.head_extra()}

    </head>

    <body id="body">

     ## IE hacks

                    </tr>

                %endfor

                </tbody>

                </table>

                <div class="pagination-wh pagination-left">

                    ${c.pagination.pager('$link_previous ~2~ $link_next')}

                </div>

            </div>

        </div>

        <script type="text/javascript" src="${h.url('/js/graph.js')}"></script>

        <script type="text/javascript">

            YAHOO.util.Event.onDOMReady(function(){

                //Monitor range checkboxes and build a link to changesets

                //ranges

                var checkboxes = YUD.getElementsByClassName('changeset_range');

                var url_tmpl = "${h.url('changeset_home',repo_name=c.repo_name,revision='__REVRANGE__')}";

                var pr_tmpl = "${h.url('pullrequest_home',repo_name=c.repo_name)}";

                var checkbox_checker = function(e){

                    var checked_checkboxes = [];

                    for (pos in checkboxes){

                        if(checkboxes[pos].checked){

                            checked_checkboxes.push(checkboxes[pos]);

                        }

                    }

                    if(YUD.get('open_new_pr')){

                        if(checked_checkboxes.length>1){

                            YUD.setStyle('open_new_pr','display','none');

                        } else {

                            YUD.setStyle('open_new_pr','display','');

                            if(checked_checkboxes.length>0){

                                YUD.get('open_new_pr').innerHTML = _TM['Open new pull request for selected changesets'];

                            }else{

                                YUD.get('open_new_pr').innerHTML = _TM['Open new pull request'];

                            }

                        }

                    }

                    if(checked_checkboxes.length>0){

                        var rev_end = checked_checkboxes[0].name;

                        var rev_start = checked_checkboxes[checked_checkboxes.length-1].name;

                        var url = url_tmpl.replace('__REVRANGE__',

                                rev_start+'...'+rev_end);

                        var link = (rev_start == rev_end)

                        link = link.replace('__S',rev_start.substr(0,6));

                        link = link.replace('__E',rev_end.substr(0,6));

                        YUD.get('rev_range_container').href = url;

                        YUD.get('rev_range_container').innerHTML = link;

                        YUD.setStyle('rev_range_container','display','');

                        YUD.setStyle('rev_range_clear','display','');

                        YUD.get('open_new_pr').href = pr_tmpl + '?rev_start={0}&rev_end={1}'.format(rev_start,rev_end);

                        YUD.setStyle('compare_fork','display','none');

                    }else{

                        YUD.setStyle('rev_range_container','display','none');

                        YUD.setStyle('rev_range_clear','display','none');

                        if (checkboxes){

                            YUD.get('open_new_pr').href = pr_tmpl + '?rev_end={0}'.format(checkboxes[0].name);

                        }

                        YUD.setStyle('compare_fork','display','');

                    }

                };

                YUE.onDOMReady(checkbox_checker);

                YUE.on(checkboxes,'click', checkbox_checker);

                YUE.on('rev_range_clear','click',function(e){

                    for (var i=0; i<checkboxes.length; i++){

                        var cb = checkboxes[i];

                        cb.checked = false;

                    }

                    checkbox_checker();

                    YUE.preventDefault(e);

                });

                var msgs = YUQ('.message');

                // get first element height

                var el = YUQ('#graph_content .container')[0];

                var row_h = el.clientHeight;

                for(var i=0;i<msgs.length;i++){

                    var m = msgs[i];

                    var h = m.clientHeight;

                    var pad = YUD.getStyle(m,'padding');

                    if(h > row_h){

                        var offset = row_h - (h+12);

                        YUD.setStyle(m.nextElementSibling,'display','block');

                        YUD.setStyle(m.nextElementSibling,'margin-top',offset+'px');

                    };

                }

                YUE.on(YUQ('.expand'),'click',function(e){

                    var elem = e.currentTarget.parentNode.parentNode;

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

<%inherit file="/base/base.html"/>

<%def name="title()">

    ${_('%s Changesets') % c.repo_name} - r${c.cs_ranges[0].revision}:${h.short_id(c.cs_ranges[0].raw_id)} -> r${c.cs_ranges[-1].revision}:${h.short_id(c.cs_ranges[-1].raw_id)} · ${c.rhodecode_name}

</%def>

<%def name="breadcrumbs_links()">

    ${h.link_to(_(u'Home'),h.url('/'))}

    »

    ${h.link_to(c.repo_name,h.url('summary_home',repo_name=c.repo_name))}

    »

    ${_('Changesets')} - r${c.cs_ranges[0].revision}:${h.short_id(c.cs_ranges[0].raw_id)} -> r${c.cs_ranges[-1].revision}:${h.short_id(c.cs_ranges[-1].raw_id)}

</%def>

<%def name="page_nav()">

    ${self.menu('changelog')}

</%def>

<%def name="main()">

<div class="box">

    <!-- box / title -->

    <div class="title">

        ${self.breadcrumbs()}

    </div>

    <div class="table">

        <div id="body" class="diffblock">

            <div class="code-header cv">

                <div>

                </div>

            </div>

        </div>

        <div id="changeset_compare_view_content">

            <div class="container">

            <table class="compare_view_commits noborder">

            %for cnt,cs in enumerate(c.cs_ranges):

                <tr>

                <td><div class="gravatar"><img alt="gravatar" src="${h.gravatar_url(h.email_or_none(cs.author),14)}"/></div></td>

                <td>${h.link_to('r%s:%s' % (cs.revision,h.short_id(cs.raw_id)),h.url('changeset_home',repo_name=c.repo_name,revision=cs.raw_id))}</td>

                <td><div class="author">${h.person(cs.author)}</div></td>

                <td><span class="tooltip" title="${h.age(cs.date)}">${cs.date}</span></td>

                <td>

                  %if c.statuses:

                    <div title="${h.tooltip(_('Changeset status'))}" class="changeset-status-ico"><img src="${h.url('/images/icons/flag_status_%s.png' % c.statuses[cnt])}" /></div>

                  %endif

                </td>

                <td><div class="message">${h.urlify_commit(h.wrap_paragraphs(cs.message),c.repo_name)}</div></td>

                </tr>

            %endfor

            </table>

            </div>

            <div style="font-size:1.1em;font-weight: bold;clear:both;padding-top:10px">${_('Files affected')}</div>

            <div class="cs_files">

                   %for cs in c.cs_ranges:

                       <div class="cur_cs">${h.link_to('r%s:%s' % (cs.revision,h.short_id(cs.raw_id)),h.url('changeset_home',repo_name=c.repo_name,revision=cs.raw_id))}</div>

                      %for FID, (cs1, cs2, change, path, diff, stats) in c.changes[cs.raw_id].iteritems():

                        <div class="cs_${change}">${h.link_to(h.safe_unicode(path),h.url.current(anchor=FID))}</div>

                      %endfor

                   %endfor

            </div>

        </div>

    </div>

    <%namespace name="comment" file="/changeset/changeset_file_comment.html"/>

    <%namespace name="diff_block" file="/changeset/diff_block.html"/>

     %for cs in c.cs_ranges:

          ##${comment.comment_inline_form(cs)}

          ## diff block

          <div class="h3">

          <a class="tooltip" title="${h.tooltip(cs.message)}" href="${h.url('changeset_home',repo_name=c.repo_name,revision=cs.raw_id)}">${'r%s:%s' % (cs.revision,h.short_id(cs.raw_id))}</a>

             <div class="gravatar">

                 <img alt="gravatar" src="${h.gravatar_url(h.email_or_none(cs.author),20)}"/>

             </div>

             <div class="right">

              <span class="logtags">

                %if len(cs.parents)>1:

                <span class="merge">${_('merge')}</span>

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

<%inherit file="/base/base.html"/>

<%def name="title()">

    ${_('%s Compare') % c.repo_name} - ${'%s@%s' % (c.org_repo.repo_name, c.org_ref)} -> ${'%s@%s' % (c.other_repo.repo_name, c.other_ref)} · ${c.rhodecode_name}

</%def>

<%def name="breadcrumbs_links()">

    ${h.link_to(_(u'Home'),h.url('/'))}

    »

    ${h.repo_link(c.rhodecode_db_repo.groups_and_repo)}

    »

    ${_('compare')}

</%def>

<%def name="page_nav()">

    ${self.menu('changelog')}

</%def>

<%def name="main()">

<div class="box">

    <!-- box / title -->

    <div class="title">

        ${self.breadcrumbs()}

    </div>

    <div class="table">

        <div id="body" class="diffblock">

            <div class="code-header cv">

                <div>

                ${'%s@%s' % (c.org_repo.repo_name, c.org_ref)} -&gt; ${'%s@%s' % (c.other_repo.repo_name, c.other_ref)}  <a href="${c.swap_url}">[swap]</a>

                </div>

            </div>

        </div>

        <div id="changeset_compare_view_content">

            ##CS

            <div style="font-size:1.1em;font-weight: bold;clear:both;padding-top:10px">${ungettext('Showing %s commit','Showing %s commits', len(c.cs_ranges)) % len(c.cs_ranges)}</div>

            <%include file="compare_cs.html" />

            ## FILES

            <div style="font-size:1.1em;font-weight: bold;clear:both;padding-top:10px">

            % if c.limited_diff:

                ${ungettext('%s file changed', '%s files changed', len(c.files)) % len(c.files)}

            % else:

                ${ungettext('%s file changed with %s insertions and %s deletions','%s files changed with %s insertions and %s deletions', len(c.files)) % (len(c.files),c.lines_added,c.lines_deleted)}:

            %endif

            </div>

            <div class="cs_files">

              %if not c.files:

                 <span class="empty_data">${_('No files')}</span>

              %endif

              %for fid, change, f, stat in c.files:

                  <div class="cs_${change}">

                    <div class="node">${h.link_to(h.safe_unicode(f),h.url.current(anchor=fid, **request.GET.mixed()))}</div>

                    <div class="changes">${h.fancy_file_stats(stat)}</div>

                  </div>

              %endfor

            </div>

            % if c.limited_diff:

              <h5>${_('Changeset was too big and was cut off...')} <a href="${h.url.current(fulldiff=1, **request.GET.mixed())}" onclick="return confirm('${_("confirm to show potentially huge diff")}')">${_('Show full diff')}</a></h5>

            % endif

        </div>

    </div>

    ## diff block

    <%namespace name="diff_block" file="/changeset/diff_block.html"/>

    %for fid, change, f, stat in c.files:

      ${diff_block.diff_block_simple([c.changes[fid]])}

    %endfor

    % if c.limited_diff:

      <h4>${_('Changeset was too big and was cut off...')} <a href="${h.url.current(fulldiff=1, **request.GET.mixed())}" onclick="return confirm('${_("confirm to show potentially huge diff")}')">${_('Show full diff')}</a></h4>

    % endif

     <script type="text/javascript">

      YUE.onDOMReady(function(){