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  * Return a deep copy of a given remote_repo. The result should be
  92  * freed with got_repo_free_remote_repo_data() and then free(3).
  93  * Return NULL on failure.
  94  */
  95 const struct got_error *got_repo_remote_repo_dup(struct got_remote_repo **,
  96     const struct got_remote_repo *);
  97
  98 /*
  99  * Free data allocated for the specified remote repository.
 100  * Do not free the remote_repo pointer itself.
 101  */
 102 void got_repo_free_remote_repo_data(struct got_remote_repo *);
 103
 104 /* Obtain the list of remote repositories parsed from gitconfig. */
 105 void got_repo_get_gitconfig_remotes(int *, const struct got_remote_repo **,
 106     struct got_repository *);
 107
 108 /*
 109  * Obtain a parsed representation of this repository's got.conf file.
 110  * Return NULL if this configuration file could not be read.
 111  */
 112 const struct got_gotconfig *got_repo_get_gotconfig(struct got_repository *);
 113
 114 /*
 115  * Obtain paths to various directories within a repository.
 116  * The caller must dispose of a path with free(3).
 117  */
 118 char *got_repo_get_path_objects(struct got_repository *);
 119 char *got_repo_get_path_objects_pack(struct got_repository *);
 120 char *got_repo_get_path_refs(struct got_repository *);
 121 char *got_repo_get_path_packed_refs(struct got_repository *);
 122 char *got_repo_get_path_gitconfig(struct got_repository *);
 123 char *got_repo_get_path_gotconfig(struct got_repository *);
 124
 125 struct got_reference;
 126 struct got_reflist_head;
 127
 128 /*
 129  * Obtain a reference, by name, from a repository.
 130  * The caller must dispose of it with got_ref_close().
 131  */
 132 const struct got_error *got_repo_get_reference(struct got_reference **,
 133     struct got_repository *, const char *);
 134
 135
 136 /* Indicate whether this is a bare repositiry (contains no git working tree). */
 137 int got_repo_is_bare(struct got_repository *);
 138
 139 /* Attempt to map an arbitrary path to a path within the repository. */
 140 const struct got_error *got_repo_map_path(char **, struct got_repository *,
 141     const char *);
 142
 143 /*
 144  * Create a new repository with optional specified
 145  * HEAD ref in an empty directory at a specified path.
 146  */
 147 const struct got_error *got_repo_init(const char *, const char *,
 148     enum got_hash_algorithm);
 149
 150 /* Attempt to find a unique object ID for a given ID string prefix. */
 151 const struct got_error *got_repo_match_object_id_prefix(struct got_object_id **,
 152     const char *, int, struct got_repository *);
 153
 154 /*
 155  * Given an object ID string or reference name, attempt to find a corresponding
 156  * object.
 157  * The object type may be restricted to commit, tree, blob, or tag.
 158  * Tags will only be matched if a list of references is provided.
 159  * GOT_OBJ_TYPE_ANY will match any type of object.
 160  * A human-readable label can optionally be returned, which the caller should
 161  * dispose of with free(3).
 162  * Return GOT_ERR_NO_OBJ if no matching commit can be found.
 163  */
 164 const struct got_error *got_repo_match_object_id(struct got_object_id **,
 165     char **, const char *, int, struct got_reflist_head *,
 166     struct got_repository *);
 167
 168 /*
 169  * Search the provided list of references for a tag with a given name
 170  * and target object type.
 171  * Return GOT_ERR_NO_OBJ if no matching tag can be found.
 172  */
 173 const struct got_error *got_repo_object_match_tag(struct got_tag_object **,
 174     const char *, int, struct got_reflist_head *, struct got_repository *);
 175
 176 /* A callback function which is invoked when a path is imported. */
 177 typedef const struct got_error *(*got_repo_import_cb)(void *, const char *);
 178
 179 /*
 180  * Import an unversioned directory tree into the repository.
 181  * Creates a root commit, i.e. a commit with zero parents.
 182  */
 183 const struct got_error *got_repo_import(struct got_object_id **, const char *,
 184     const char *, const char *, struct got_pathlist_head *,
 185     struct got_repository *, got_repo_import_cb, void *);
 186
 187 /* Obtain the number and size of loose objects in the repository. */
 188 const struct got_error *got_repo_get_loose_object_info(int *nobjects,
 189     off_t *ondisk_size, struct got_repository *);
 190
 191 /* Obtain the number and size of packed objects in the repository. */
 192 const struct got_error *got_repo_get_packfile_info(int *npackfiles,
 193     int *nobjects, off_t *total_packsize, struct got_repository *);
 194
 195 /* Create an array of file descriptors to hand over to got_repo_open for pack */
 196 const struct got_error *got_repo_pack_fds_open(int **);
 197
 198 /* Close the array of file descriptors handed over to got_repo_open for pack */
 199 const struct got_error *got_repo_pack_fds_close(int *);
 200
 201 /* Open/set/close temporary files for internal use. Needed by gotd(8). */
 202 const struct got_error *got_repo_temp_fds_open(int **);
 203 void got_repo_temp_fds_set(struct got_repository *, int *);
 204 const struct got_error *got_repo_temp_fds_close(int *);