kallithea Changeset - 50906cedb924

Changeset - 50906cedb924

Parent rev.

Child rev.

[Not reviewed]

default

0 5 0

Mads Kiilerich (mads) - 5 years ago 2020-11-03 12:52:03
mads@kiilerich.com

Grafted from: c4999bd1ba66

hooks: clarify some comments

5 files changed with 12 insertions and 12 deletions:

kallithea/config/middleware/simplegit.py

kallithea/lib/hooks.py

kallithea/lib/utils2.py

kallithea/lib/vcs/ssh/base.py

kallithea/lib/vcs/ssh/git.py

0 comments (0 inline, 0 general)

kallithea/config/middleware/simplegit.py

➞

Show inline comments

@@ @@ -80,19 +80,19 @@ class SimpleGit(BaseVCSController): @@
         """
         Return a pygrack wsgi application.
         """
         pygrack_app = make_wsgi_app(parsed_request.repo_name, self.basepath)
         def wrapper_app(environ, start_response):
             if (parsed_request.cmd == 'info/refs' and
                 parsed_request.service == 'git-upload-pack'
             ):
                 baseui = make_ui()
                 repo = db.Repository.get_by_repo_name(parsed_request.repo_name)
                 scm_repo = repo.scm_instance
-                # Run hooks, like Mercurial outgoing.pull_logger does
+                # Run hooks like Mercurial outgoing.kallithea_log_pull_action does
                 hooks.log_pull_action(ui=baseui, repo=scm_repo._repo)
             # Note: push hooks are handled by post-receive hook
             return pygrack_app(environ, start_response)
         return wrapper_app

kallithea/lib/hooks.py

➞

Show inline comments

@@ @@ -328,25 +328,25 @@ def handle_git_pre_receive(repo_path, gi @@
     """
     # Currently unused. TODO: remove?
     return 0
 def handle_git_post_receive(repo_path, git_stdin_lines):
     """Called from Git post-receive hook.
     The returned value is used as hook exit code and must be 0.
     """
     try:
         baseui, repo = _hook_environment(repo_path)
     except HookEnvironmentError as e:
-        sys.stderr.write("Skipping Kallithea Git post-recieve hook %r.\nGit was apparently not invoked by Kallithea: %s\n" % (sys.argv[0], e))
+        sys.stderr.write("Skipping Kallithea Git post-receive hook %r.\nGit was apparently not invoked by Kallithea: %s\n" % (sys.argv[0], e))
         return 0
     # the post push hook should never use the cached instance
     scm_repo = repo.scm_instance_no_cache()
     rev_data = []
     for l in git_stdin_lines:
         old_rev, new_rev, ref = l.strip().split(' ')
         _ref_data = ref.split('/')
         if _ref_data[1] in ['tags', 'heads']:
             rev_data.append({'old_rev': old_rev,
                              'new_rev': new_rev,

kallithea/lib/utils2.py

➞

Show inline comments

@@ @@ -484,29 +484,29 @@ def get_hook_environment(): @@
 def set_hook_environment(username, ip_addr, repo_name, repo_alias, action=None):
     """Prepare global context for running hooks by serializing data in the
     global KALLITHEA_EXTRAS environment variable.
     Most importantly, this allow Git hooks to do proper logging and updating of
     caches after pushes.
     Must always be called before anything with hooks are invoked.
     """
     extras = {
-        'ip': ip_addr, # used in log_push/pull_action action_logger
         'ip': ip_addr, # used in action_logger
         'username': username,
-        'action': action or 'push_local', # used in log_push_action_raw_ids action_logger
+        'action': action or 'push_local', # used in process_pushed_raw_ids action_logger
         'repository': repo_name,
-        'scm': repo_alias, # used to pick hack in log_push_action_raw_ids
         'scm': repo_alias,
         'config': kallithea.CONFIG['__file__'], # used by git hook to read config
+    }
     os.environ['KALLITHEA_EXTRAS'] = json.dumps(extras)
 def get_current_authuser():
     """
     Gets kallithea user from threadlocal tmpl_context variable if it's
     defined, else returns None.
     """
     try:
         return getattr(tmpl_context, 'authuser', None)

kallithea/lib/vcs/ssh/base.py

➞

Show inline comments

@@ @@ -80,29 +80,29 @@ class BaseSshHandler(object): @@
             self.allow_push = True
         elif HasPermissionAnyMiddleware('repository.read')(self.authuser, self.repo_name):
             self.allow_push = False
         else:
             self.exit('Access to %r denied' % self.repo_name)
         self.db_repo = db.Repository.get_by_repo_name(self.repo_name)
         if self.db_repo is None:
             self.exit("Repository '%s' not found" % self.repo_name)
         assert self.db_repo.repo_name == self.repo_name
         # Set global hook environment up for 'push' actions.
         # If pull actions should be served, the actual hook invocation will be
         # hardcoded to 'pull' when log_pull_action is invoked (directly on Git,
         # or through the Mercurial 'outgoing' hook).
         # For push actions, the action in global hook environment is used (in
         # handle_git_post_receive when it is called as Git post-receive hook,
         # or in log_push_action through the Mercurial 'changegroup' hook).
         # For push actions, the action in global hook environment is used in
         # process_pushed_raw_ids (which it is called as Git post-receive hook,
         # or Mercurial 'changegroup' hook).
         # For pull actions, the actual hook in log_pull_action (called directly
         # on Git, or through the 'outgoing' Mercurial hook) is hardcoded to
         # ignore the environment action and always use 'pull'.
         set_hook_environment(self.authuser.username, client_ip, self.repo_name, self.vcs_type, 'push')
         return self._serve()
     def _serve(self):
         """Serve the native protocol for repository access."""
         raise NotImplementedError
     def exit(self, error):
         log.info('abort serving %s %s: %s', self.vcs_type, self.repo_name, error)
         sys.stderr.write('abort: %s\n' % error)
         sys.exit(1)

kallithea/lib/vcs/ssh/git.py

➞

Show inline comments

@@ @@ -56,25 +56,25 @@ class GitSshHandler(base.BaseSshHandler) @@
             ssh_command_parts[1].startswith('/')
         ):
             return cls(ssh_command_parts[1][1:], ssh_command_parts[0])
         return None
     def __init__(self, repo_name, verb):
         base.BaseSshHandler.__init__(self, repo_name)
         self.verb = verb
     def _serve(self):
         if self.verb == 'git-upload-pack': # action 'pull'
-            # base class called set_hook_environment - action is hardcoded to 'pull'
+            # base class called set_hook_environment with 'push' action ... but log_pull_action ignores that and will 'pull'
             hooks.log_pull_action(ui=make_ui(), repo=self.db_repo.scm_instance._repo)
         else: # probably verb 'git-receive-pack', action 'push'
             if not self.allow_push:
                 self.exit('Push access to %r denied' % self.repo_name)
             # Note: push logging is handled by Git post-receive hook
         # git shell is not a real shell but use shell inspired quoting *inside* the argument.
         # Per https://github.com/git/git/blob/v2.22.0/quote.c#L12 :
         # The path must be "'" quoted, but "'" and "!" must exit the quoting and be "\" escaped
         quoted_abspath = "'%s'" % self.db_repo.repo_full_path.replace("'", r"'\''").replace("!", r"'\!'")
         newcmd = ['git', 'shell', '-c', "%s %s" % (self.verb, quoted_abspath)]
         log.debug('Serving: %s', newcmd)

0 comments (0 inline, 0 general)