include/got_repository.h

   1 /*
   2  * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
   3  *
   4  * Permission to use, copy, modify, and distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 struct got_repository;
  18 struct got_pathlist_head;
  19 struct got_tag_object;
  20
  21 /* Open and close repositories. */
  22 const struct got_error *got_repo_open(struct got_repository**, const char *,
  23     const char *, int *);
  24 const struct got_error *got_repo_close(struct got_repository*);
  25
  26 /* Obtain the on-disk path to the repository. */
  27 const char *got_repo_get_path(struct got_repository *);
  28
  29 /*
  30  * Obtain the path to a non-bare repository's .git directory.
  31  * For bare repositories, this returns the same result as got_repo_get_path().
  32  */
  33 const char *got_repo_get_path_git_dir(struct got_repository *);
  34
  35 /* Obtain the file descriptor of the repository's .git directory. */
  36 int got_repo_get_fd(struct got_repository *);
  37
  38 /* Obtain the object format */
  39 enum got_hash_algorithm got_repo_get_object_format(struct got_repository *);
  40
  41 /* Obtain the commit author name if parsed from gitconfig, else NULL. */
  42 const char *got_repo_get_gitconfig_author_name(struct got_repository *);
  43
  44 /* Obtain the commit author email if parsed from gitconfig, else NULL. */
  45 const char *got_repo_get_gitconfig_author_email(struct got_repository *);
  46
  47 /* Obtain global commit author name parsed ~/.gitconfig, else NULL. */
  48 const char *got_repo_get_global_gitconfig_author_name(struct got_repository *);
  49
  50 /* Obtain global commit author email parsed ~/.gitconfig, else NULL. */
  51 const char *got_repo_get_global_gitconfig_author_email(struct got_repository *);
  52
  53 /* Obtain repository owner name if parsed from gitconfig, else NULL. */
  54 const char *got_repo_get_gitconfig_owner(struct got_repository *);
  55
  56 /* Query if a given Git extension is enabled in gitconfig. */
  57 int got_repo_has_extension(struct got_repository *, const char *);
  58
  59 /* Information about one remote repository. */
  60 struct got_remote_repo {
  61         char *name;
  62         char *fetch_url;
  63         char *send_url;
  64
  65         /*
  66          * If set, fetched references are mirrored 1:1 into our repository.
  67          * If not set, references are mapped into "refs/remotes/$name/".
  68          */
  69         int mirror_references;
  70
  71         /*
  72          * If set, fetch all branches by default and ignore the list of
  73          * branches below.
  74          */
  75         int fetch_all_branches;
  76
  77         /* Branches to fetch by default. */
  78         int nfetch_branches;
  79         char **fetch_branches;
  80
  81         /* Branches to send by default. */
  82         int nsend_branches;
  83         char **send_branches;
  84
  85         /* Other arbitrary references to fetch by default. */
  86         int nfetch_refs;
  87         char **fetch_refs;
  88 };
  89
  90 /*
  91  * Free data allocated for the specified remote repository.
  92  * Do not free the remote_repo pointer itself.
  93  */
  94 void got_repo_free_remote_repo_data(struct got_remote_repo *);
  95
  96 /* Obtain the list of remote repositories parsed from gitconfig. */
  97 void got_repo_get_gitconfig_remotes(int *, const struct got_remote_repo **,
  98     struct got_repository *);
  99
 100 /*
 101  * Obtain a parsed representation of this repository's got.conf file.
 102  * Return NULL if this configuration file could not be read.
 103  */
 104 const struct got_gotconfig *got_repo_get_gotconfig(struct got_repository *);
 105
 106 /*
 107  * Obtain paths to various directories within a repository.
 108  * The caller must dispose of a path with free(3).
 109  */
 110 char *got_repo_get_path_objects(struct got_repository *);
 111 char *got_repo_get_path_objects_pack(struct got_repository *);
 112 char *got_repo_get_path_refs(struct got_repository *);
 113 char *got_repo_get_path_packed_refs(struct got_repository *);
 114 char *got_repo_get_path_gitconfig(struct got_repository *);
 115 char *got_repo_get_path_gotconfig(struct got_repository *);
 116
 117 struct got_reference;
 118 struct got_reflist_head;
 119
 120 /*
 121  * Obtain a reference, by name, from a repository.
 122  * The caller must dispose of it with got_ref_close().
 123  */
 124 const struct got_error *got_repo_get_reference(struct got_reference **,
 125     struct got_repository *, const char *);
 126
 127
 128 /* Indicate whether this is a bare repositiry (contains no git working tree). */
 129 int got_repo_is_bare(struct got_repository *);
 130
 131 /* Attempt to map an arbitrary path to a path within the repository. */
 132 const struct got_error *got_repo_map_path(char **, struct got_repository *,
 133     const char *);
 134
 135 /*
 136  * Create a new repository with optional specified
 137  * HEAD ref in an empty directory at a specified path.
 138  */
 139 const struct got_error *got_repo_init(const char *, const char *);
 140
 141 /* Attempt to find a unique object ID for a given ID string prefix. */
 142 const struct got_error *got_repo_match_object_id_prefix(struct got_object_id **,
 143     const char *, int, struct got_repository *);
 144
 145 /*
 146  * Given an object ID string or reference name, attempt to find a corresponding
 147  * object.
 148  * The object type may be restricted to commit, tree, blob, or tag.
 149  * Tags will only be matched if a list of references is provided.
 150  * GOT_OBJ_TYPE_ANY will match any type of object.
 151  * A human-readable label can optionally be returned, which the caller should
 152  * dispose of with free(3).
 153  * Return GOT_ERR_NO_OBJ if no matching commit can be found.
 154  */
 155 const struct got_error *got_repo_match_object_id(struct got_object_id **,
 156     char **, const char *, int, struct got_reflist_head *,
 157     struct got_repository *);
 158
 159 /*
 160  * Search the provided list of references for a tag with a given name
 161  * and target object type.
 162  * Return GOT_ERR_NO_OBJ if no matching tag can be found.
 163  */
 164 const struct got_error *got_repo_object_match_tag(struct got_tag_object **,
 165     const char *, int, struct got_reflist_head *, struct got_repository *);
 166
 167 /* A callback function which is invoked when a path is imported. */
 168 typedef const struct got_error *(*got_repo_import_cb)(void *, const char *);
 169
 170 /*
 171  * Import an unversioned directory tree into the repository.
 172  * Creates a root commit, i.e. a commit with zero parents.
 173  */
 174 const struct got_error *got_repo_import(struct got_object_id **, const char *,
 175     const char *, const char *, struct got_pathlist_head *,
 176     struct got_repository *, got_repo_import_cb, void *);
 177
 178 /* Obtain the number and size of loose objects in the repository. */
 179 const struct got_error *got_repo_get_loose_object_info(int *nobjects,
 180     off_t *ondisk_size, struct got_repository *);
 181
 182 /* Obtain the number and size of packed objects in the repository. */
 183 const struct got_error *got_repo_get_packfile_info(int *npackfiles,
 184     int *nobjects, off_t *total_packsize, struct got_repository *);
 185
 186 /* Create an array of file descriptors to hand over to got_repo_open for pack */
 187 const struct got_error *got_repo_pack_fds_open(int **);
 188
 189 /* Close the array of file descriptors handed over to got_repo_open for pack */
 190 const struct got_error *got_repo_pack_fds_close(int *);
 191
 192 /* Open/set/close temporary files for internal use. Needed by gotd(8). */
 193 const struct got_error *got_repo_temp_fds_open(int **);
 194 void got_repo_temp_fds_set(struct got_repository *, int *);
 195 const struct got_error *got_repo_temp_fds_close(int *);