aboutsummaryrefslogtreecommitdiff
path: root/gitosis/gitweb.py
blob: 25076b13767eda7507549f8eea9f4266919a4baa (plain)
1
2
3
4
5
6
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
"""
Generate ``gitweb`` project list based on ``gitosis.conf``.
 
To plug this into ``gitweb``, you have two choices.
 
- The global way, edit ``/etc/gitweb.conf`` to say::
 
    $projects_list = "/path/to/your/projects.list";
 
  Note that there can be only one such use of gitweb.
 
- The local way, create a new config file::
 
    do "/etc/gitweb.conf" if -e "/etc/gitweb.conf";
    $projects_list = "/path/to/your/projects.list";
        # see ``repositories`` in the ``gitosis`` section
        # of ``~/.gitosis.conf``; usually ``~/repositories``
        # but you need to expand the tilde here
    $projectroot = "/path/to/your/repositories";
 
   Then in your web server, set environment variable ``GITWEB_CONFIG``
   to point to this file.
 
   This way allows you have multiple separate uses of ``gitweb``, and
   isolates the changes a bit more nicely. Recommended.
"""
 
import osurlliblogging
 
from ConfigParser import NoSectionErrorNoOptionError
 
from gitosis import util
from gitosis.configutil import getboolean_default
 
def _escape_filename(i):
    """Try to make the filename safer."""
    i = i.replace('\\''\\\\')
    i = i.replace('$''\\$')
    i = i.replace('"''\\"')
    return i
 
def generate_project_list_fp(config, fp):
    """
    Generate projects list for ``gitweb``.
 
    :param config: configuration to read projects from
    :type config: RawConfigParser
 
    :param fp: writable for ``projects.list``
    :type fp: (file-like, anything with ``.write(data)``)
    """
    log = logging.getLogger('gitosis.gitweb.generate_projects_list')
 
    repositories = util.getRepositoryDir(config)
 
    global_enable = getboolean_default(config'gitosis''gitweb'False)
 
    for section in config.sections():
        sectiontitle = section.split(None1)
        if not sectiontitle or sectiontitle[0] != 'repo':
            continue
 
        enable = getboolean_default(configsection'gitweb'global_enable)
 
        if not enable:
            continue
 
        name = sectiontitle[1]
 
        name = _repository_exists(logrepositoriesnamename)
 
        response = [name]
        try:
            owner = config.get(section'owner')
        except (NoSectionErrorNoOptionError):
            pass
        else:
            response.append(owner)
 
        line = ' '.join([urllib.quote_plus(_) for _ in response])
        print >> fpline
 
 
def _repository_exists(log, repositories, name, default_value):
    """
    Check if the repository exists by the common name, or with a .git suffix,
    and return the relative name.
    """
    if not os.path.exists(os.path.join(repositoriesname)):
        namedotgit = '%s.git' % name
        if os.path.exists(os.path.join(repositoriesnamedotgit)):
            name = namedotgit
        else:
            log.warning(
                    'Cannot find %(name)r in %(repositories)r'
                    % dict(name=name, repositories=repositories))
            return default_value
    return name
 
def generate_project_list(config, path):
    """
    Generate projects list for ``gitweb``.
 
    :param config: configuration to read projects from
    :type config: RawConfigParser
 
    :param path: path to write projects list to
    :type path: str
    """
    tmp = '%s.%d.tmp' % (pathos.getpid())
 
    fp = file(tmp'w')
    try:
        generate_project_list_fp(config=config, fp=fp)
    finally:
        fp.close()
 
    os.rename(tmppath)
 
 
def set_descriptions(config):
    """
    Set descriptions for gitweb use.
    """
    log = logging.getLogger('gitosis.gitweb.set_descriptions')
 
    repositories = util.getRepositoryDir(config)
 
    for section in config.sections():
        sectiontitle = section.split(None1)
        if not sectiontitle or sectiontitle[0] != 'repo':
            continue
 
        try:
            description = config.get(section'description')
        except (NoSectionErrorNoOptionError):
            continue
 
        if not description#pragma: no cover 
            continue
 
        name = sectiontitle[1]
 
        name = _repository_exists(logrepositoriesnameFalse)
        if not name:
            continue
 
        path = os.path.join(
            repositories,
            name,
            'description',
            )
        tmp = '%s.%d.tmp' % (pathos.getpid())
        fp = file(tmp'w')
        try:
            print >> fpdescription
        finally:
            fp.close()
        os.rename(tmppath)