12075bff8d4768ab74aa84b44ab8e84a11b770b6
[git-mirror.git] / git_mirror.py
1 # Copyright (c) 2015, Ralf Jung <post@ralfj.de>
2 # All rights reserved.
3
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are met:
6
7 # 1. Redistributions of source code must retain the above copyright notice, this
8 #    list of conditions and the following disclaimer. 
9 # 2. Redistributions in binary form must reproduce the above copyright notice,
10 #    this list of conditions and the following disclaimer in the documentation
11 #    and/or other materials provided with the distribution.
12
13 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
14 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16 # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
17 # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
20 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 #==============================================================================
24 import sys, os, os.path, subprocess
25 import configparser, itertools, re
26 import hmac, hashlib
27 import email.mime.text, email.utils, smtplib
28
29 mail_sender = "null@localhost"
30 config_file = os.path.join(os.path.dirname(__file__), 'git-mirror.conf')
31
32 class GitCommand:
33     def __getattr__(self, name):
34         def call(*args, capture_stderr = False, check = True):
35             '''If <capture_stderr>, return stderr merged with stdout. Otherwise, return stdout and forward stderr to our own.
36                If <check> is true, throw an exception of the process fails with non-zero exit code. Otherwise, do not.
37                In any case, return a pair of the captured output and the exit code.'''
38             cmd = ["git", name.replace('_', '-')] + list(args)
39             with subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT if capture_stderr else sys.stderr) as p:
40                 (stdout, stderr) = p.communicate()
41                 assert stderr is None
42                 code = p.returncode
43                 if check and code:
44                     raise Exception("Error running {}: Non-zero exit code".format(cmd))
45             return (stdout.decode('utf-8').strip('\n'), code)
46         return call
47
48 git = GitCommand()
49 git_nullsha = 40*"0"
50
51 def git_is_forced_update(oldsha, newsha):
52     out, code = git.merge_base("--is-ancestor", oldsha, newsha, check = False) # "Check if the first <commit> is an ancestor of the second <commit>"
53     assert not out
54     assert code in (0, 1)
55     return False if code == 0 else True # if oldsha is an ancestor of newsha, then this was a "good" (non-forced) update
56
57 def read_config(defSection = 'DEFAULT'):
58     '''Reads a config file that may have options outside of any section.'''
59     config = configparser.ConfigParser()
60     with open(config_file) as file:
61         stream = itertools.chain(("["+defSection+"]\n",), file)
62         config.read_file(stream)
63     return config
64
65 def send_mail(subject, text, recipients, sender, replyTo = None):
66     assert isinstance(recipients, list)
67     if not len(recipients): return # nothing to do
68     # construct content
69     msg = email.mime.text.MIMEText(text.encode('UTF-8'), 'plain', 'UTF-8')
70     msg['Subject'] = subject
71     msg['Date'] = email.utils.formatdate(localtime=True)
72     msg['From'] = sender
73     msg['To'] = ', '.join(recipients)
74     if replyTo is not None:
75         msg['Reply-To'] = replyTo
76     # put into envelope and send
77     s = smtplib.SMTP('localhost')
78     s.sendmail(sender, recipients, msg.as_string())
79     s.quit()
80
81 class Repo:
82     def __init__(self, name, conf):
83         '''Creates a repository from a section of the git-mirror configuration file'''
84         self.name = name
85         self.local = conf['local']
86         self.owner = conf['owner'] # email address to notify in case of problems
87         self.hmac_secret = conf['hmac-secret'].encode('utf-8') if 'hmac-secret' in conf else None
88         self.deploy_key = conf['deploy-key'] # the SSH ky used for authenticating against remote hosts
89         self.mirrors = {} # maps mirrors to their URLs
90         mirror_prefix = 'mirror-'
91         for name in filter(lambda s: s.startswith(mirror_prefix), conf.keys()):
92             mirror = name[len(mirror_prefix):]
93             self.mirrors[mirror] = conf[name]
94     
95     def mail_owner(self, msg):
96         global mail_sender
97         send_mail("git-mirror {}".format(self.name), msg, recipients = [self.owner], sender = mail_sender)
98
99     def compute_hmac(self, data):
100         assert self.hmac_secret is not None
101         h = hmac.new(self.hmac_secret, digestmod = hashlib.sha1)
102         h.update(data)
103         return h.hexdigest()
104     
105     def find_mirror_by_url(self, match_urls):
106         for mirror, url in self.mirrors.items():
107             if url in match_urls:
108                 return mirror
109         return None
110     
111     def setup_env(self):
112         '''Setup the environment to work with this repository'''
113         os.chdir(self.local)
114         ssh_set_ident = os.path.join(os.path.dirname(__file__), 'ssh-set-ident.sh')
115         os.putenv('GIT_SSH', ssh_set_ident)
116         ssh_ident = os.path.join(os.path.expanduser('~/.ssh'), self.deploy_key)
117         os.putenv('GIT_MIRROR_SSH_IDENT', ssh_ident)
118     
119     def update_mirrors(self, ref, oldsha, newsha):
120         '''Update the <ref> from <oldsha> to <newsha> on all mirrors. The update must already have happened locally.'''
121         assert len(oldsha) == 40 and len(newsha) == 40, "These are not valid SHAs."
122         source_mirror = os.getenv("GIT_MIRROR_SOURCE") # in case of a self-call via the hooks, we can skip one of the mirrors
123         self.setup_env()
124         # check for a forced update
125         is_forced = newsha != git_nullsha and oldsha != git_nullsha and git_is_forced_update(oldsha, newsha)
126         # tell all the mirrors
127         for mirror in self.mirrors:
128             if mirror == source_mirror:
129                 continue
130             sys.stdout.write("Updating mirror {}\n".format(mirror)); sys.stdout.flush()
131             # update this mirror
132             if is_forced:
133                 # forcibly update ref remotely (someone already did a force push and hence accepted data loss)
134                 git.push('--force', self.mirrors[mirror], newsha+":"+ref)
135             else:
136                 # nicely update ref remotely (this avoids data loss due to race conditions)
137                 git.push(self.mirrors[mirror], newsha+":"+ref)
138     
139     def update_ref_from_mirror(self, ref, oldsha, newsha, mirror, suppress_stderr = False):
140         '''Update the local version of this <ref> to what's currently on the given <mirror>. <oldsha> and <newsha> are checked. Then update all the other mirrors.'''
141         self.setup_env()
142         url = self.mirrors[mirror]
143         # first check whether the remote really is at newsha
144         remote_state, code = git.ls_remote(url, ref)
145         if remote_state:
146             remote_sha = remote_state.split()[0]
147         else:
148             remote_sha = git_nullsha
149         assert newsha == remote_sha, "Someone lied about the new SHA, which should be {}.".format(newsha)
150         # locally, we have to be at oldsha or newsha (the latter can happen if we already got this update, e.g. if it originated from us)
151         local_state, code = git.show_ref(ref, check=False)
152         if code == 0:
153             local_sha = local_state.split()[0]
154         else:
155             if len(local_state):
156                 raise Exception("Something went wrong getting the local state of {}.".format(ref))
157             local_sha = git_nullsha
158         # some sanity checking, but deal gracefully with new branches appearing
159         assert local_sha in (git_nullsha, oldsha, newsha), "Someone lied about the old SHA: Local ({}) is neither old ({}) nor new ({})".format(local_sha, oldsha, newsha)
160         # if we are already at newsha locally, we also ran the local hooks, so we do not have to do anything
161         if local_sha == newsha:
162             return "Local repository is already up-to-date."
163         # update local state from local_sha to newsha.
164         if newsha != git_nullsha:
165             # We *could* now fetch the remote ref and immediately update the local one. However, then we would have to
166             # decide whether we want to allow a force-update or not. Also, the ref could already have changed remotely,
167             # so that may update to some other commit.
168             # Instead, we just fetch without updating any local ref. If the remote side changed in such a way that
169             # <newsha> is not actually fetched, that's a race and will be noticed when updating the local ref.
170             git.fetch(url, ref, capture_stderr = suppress_stderr)
171             # now update the ref, checking the old value is still local_oldsha.
172             git.update_ref(ref, newsha, 40*"0" if local_sha is None else local_sha)
173         else:
174             # ref does not exist anymore. delete it.
175             assert local_sha != git_nullsha, "Why didn't we bail out earlier if there is nothing to do...?"
176             git.update_ref("-d", ref, local_sha) # this checks that the old value is still local_sha
177         # Now run the post-receive hooks. This will *also* push the changes to all mirrors, as we
178         # are one of these hooks!
179         os.putenv("GIT_MIRROR_SOURCE", mirror) # tell ourselves which repo we do *not* have to update
180         with subprocess.Popen(['hooks/post-receive'], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) as p:
181             (stdout, stderr) = p.communicate("{} {} {}\n".format(oldsha, newsha, ref).encode('utf-8'))
182             stdout = stdout.decode('utf-8')
183             if p.returncode:
184                 raise Exception("post-receive git hook terminated with non-zero exit code {}:\n{}".format(p.returncode, stdout))
185         return stdout
186
187 def find_repo_by_directory(repos, dir):
188     for (name, repo) in repos.items():
189         if dir == repo.local:
190             return name
191     return None
192
193 def load_repos():
194     global mail_sender
195     conf = read_config()
196     mail_sender = conf['DEFAULT']['mail-sender']
197     
198     repos = {}
199     for name, section in conf.items():
200         if name != 'DEFAULT':
201             repos[name] = Repo(name, section)
202     return repos
203