git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/protos.h

   1 /*
   2  * Director external function prototypes
   3  *
   4  *   Version $Id$
   5  */
   6 /*
   7    Copyright (C) 2000-2005 Kern Sibbald
   8
   9    This program is free software; you can redistribute it and/or
  10    modify it under the terms of the GNU General Public License
  11    version 2 as amended with additional clauses defined in the
  12    file LICENSE in the main source directory.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17    the file LICENSE for additional details.
  18
  19  */
  20
  21 /* admin.c */
  22 extern bool do_admin_init(JCR *jcr);
  23 extern bool do_admin(JCR *jcr);
  24 extern void admin_cleanup(JCR *jcr, int TermCode);
  25
  26
  27 /* authenticate.c */
  28 extern bool authenticate_storage_daemon(JCR *jcr, STORE *store);
  29 extern int authenticate_file_daemon(JCR *jcr);
  30 extern int authenticate_user_agent(UAContext *ua);
  31
  32 /* autoprune.c */
  33 extern int do_autoprune(JCR *jcr);
  34 extern int prune_volumes(JCR *jcr);
  35
  36 /* autorecycle.c */
  37 extern bool recycle_oldest_purged_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  38 extern int recycle_volume(JCR *jcr, MEDIA_DBR *mr);
  39 extern bool find_recycled_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  40
  41 /* backup.c */
  42 extern int wait_for_job_termination(JCR *jcr);
  43 extern bool do_backup_init(JCR *jcr);
  44 extern bool do_backup(JCR *jcr);
  45 extern void backup_cleanup(JCR *jcr, int TermCode);
  46 extern void update_bootstrap_file(JCR *jcr);
  47
  48 /* bsr.c */
  49 RBSR *new_bsr();
  50 void free_bsr(RBSR *bsr);
  51 bool complete_bsr(UAContext *ua, RBSR *bsr);
  52 uint32_t write_bsr_file(UAContext *ua, RESTORE_CTX &rx);
  53 void add_findex(RBSR *bsr, uint32_t JobId, int32_t findex);
  54 void add_findex_all(RBSR *bsr, uint32_t JobId);
  55 RBSR_FINDEX *new_findex();
  56 void make_unique_restore_filename(UAContext *ua, POOLMEM **fname);
  57
  58
  59 /* catreq.c */
  60 extern void catalog_request(JCR *jcr, BSOCK *bs);
  61 extern void catalog_update(JCR *jcr, BSOCK *bs);
  62
  63 /* dird_conf.c */
  64 extern const char *level_to_str(int level);
  65
  66 /* expand.c */
  67 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp);
  68
  69
  70 /* fd_cmds.c */
  71 extern int connect_to_file_daemon(JCR *jcr, int retry_interval,
  72                                   int max_retry_time, int verbose);
  73 extern bool send_include_list(JCR *jcr);
  74 extern bool send_exclude_list(JCR *jcr);
  75 extern bool send_bootstrap_file(JCR *jcr, BSOCK *sock);
  76 extern bool send_level_command(JCR *jcr);
  77 extern int get_attributes_and_put_in_catalog(JCR *jcr);
  78 extern int get_attributes_and_compare_to_catalog(JCR *jcr, JobId_t JobId);
  79 extern int put_file_into_catalog(JCR *jcr, long file_index, char *fname,
  80                           char *link, char *attr, int stream);
  81 extern void get_level_since_time(JCR *jcr, char *since, int since_len);
  82 extern int send_run_before_and_after_commands(JCR *jcr);
  83
  84 /* getmsg.c */
  85 enum e_prtmsg {
  86    DISPLAY_ERROR,
  87    NO_DISPLAY
  88 };
  89 extern bool response(JCR *jcr, BSOCK *fd, char *resp, const char *cmd, e_prtmsg prtmsg);
  90
  91 /* job.c */
  92 extern void set_jcr_defaults(JCR *jcr, JOB *job);
  93 extern void create_unique_job_name(JCR *jcr, const char *base_name);
  94 extern void update_job_end_record(JCR *jcr);
  95 extern bool get_or_create_client_record(JCR *jcr);
  96 extern bool get_or_create_fileset_record(JCR *jcr);
  97 extern JobId_t run_job(JCR *jcr);
  98 extern bool cancel_job(UAContext *ua, JCR *jcr);
  99 extern void init_jcr_job_record(JCR *jcr);
 100 extern void copy_storage(JCR *jcr, alist *storage);
 101 extern void set_storage(JCR *jcr, STORE *store);
 102 extern bool setup_job(JCR *jcr);
 103 extern void create_clones(JCR *jcr);
 104 extern bool create_restore_bootstrap_file(JCR *jcr);
 105
 106 /* migration.c */
 107 extern bool do_migration(JCR *jcr);
 108 extern bool do_migration_init(JCR *jcr);
 109 extern void migration_cleanup(JCR *jcr, int TermCode);
 110
 111
 112 /* mountreq.c */
 113 extern void mount_request(JCR *jcr, BSOCK *bs, char *buf);
 114
 115 /* msgchan.c */
 116 extern bool connect_to_storage_daemon(JCR *jcr, int retry_interval,
 117                               int max_retry_time, int verbose);
 118 extern bool start_storage_daemon_job(JCR *jcr, alist *rstore, alist *wstore);
 119 extern int start_storage_daemon_message_thread(JCR *jcr);
 120 extern int bget_dirmsg(BSOCK *bs);
 121 extern void wait_for_storage_daemon_termination(JCR *jcr);
 122
 123 /* next_vol.c */
 124 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, int index, bool create);
 125 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr);
 126 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason);
 127
 128 /* newvol.c */
 129 bool newVolume(JCR *jcr, MEDIA_DBR *mr);
 130
 131 /* python.c */
 132 int generate_job_event(JCR *jcr, const char *event);
 133
 134
 135 /* restore.c */
 136 extern bool do_restore(JCR *jcr);
 137 extern bool do_restore_init(JCR *jcr);
 138 extern void restore_cleanup(JCR *jcr, int TermCode);
 139
 140
 141 /* ua_acl.c */
 142 bool acl_access_ok(UAContext *ua, int acl, char *item);
 143 bool acl_access_ok(UAContext *ua, int acl, char *item, int len);
 144
 145 /* ua_cmds.c */
 146 int do_a_command(UAContext *ua, const char *cmd);
 147 int do_a_dot_command(UAContext *ua, const char *cmd);
 148 int qmessagescmd(UAContext *ua, const char *cmd);
 149 bool open_db(UAContext *ua);
 150 void close_db(UAContext *ua);
 151 enum e_pool_op {
 152    POOL_OP_UPDATE,
 153    POOL_OP_CREATE
 154 };
 155 int create_pool(JCR *jcr, B_DB *db, POOL *pool, e_pool_op op);
 156 void set_pool_dbr_defaults_in_media_dbr(MEDIA_DBR *mr, POOL_DBR *pr);
 157 void set_pooldbr_from_poolres(POOL_DBR *pr, POOL *pool, e_pool_op op);
 158
 159 /* ua_input.c */
 160 int get_cmd(UAContext *ua, const char *prompt);
 161 bool get_pint(UAContext *ua, const char *prompt);
 162 bool get_yesno(UAContext *ua, const char *prompt);
 163 void parse_ua_args(UAContext *ua);
 164
 165 /* ua_label.c */
 166 bool is_volume_name_legal(UAContext *ua, const char *name);
 167 int get_num_drives_from_SD(UAContext *ua);
 168
 169 /* ua_output.c */
 170 void prtit(void *ctx, const char *msg);
 171 int complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool);
 172 RUN *find_next_run(RUN *run, JOB *job, time_t &runtime, int ndays);
 173
 174 /* ua_restore.c */
 175 int get_next_jobid_from_list(char **p, JobId_t *JobId);
 176
 177 /* ua_server.c */
 178 void bsendmsg(void *sock, const char *fmt, ...);
 179 UAContext *new_ua_context(JCR *jcr);
 180 JCR *new_control_jcr(const char *base_name, int job_type);
 181 void free_ua_context(UAContext *ua);
 182
 183 /* ua_select.c */
 184 STORE   *select_storage_resource(UAContext *ua);
 185 JOB     *select_job_resource(UAContext *ua);
 186 JOB     *select_restore_job_resource(UAContext *ua);
 187 CLIENT  *select_client_resource(UAContext *ua);
 188 FILESET *select_fileset_resource(UAContext *ua);
 189 int     select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr);
 190 int     select_media_dbr(UAContext *ua, MEDIA_DBR *mr);
 191 bool    select_pool_dbr(UAContext *ua, POOL_DBR *pr);
 192 int     select_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 193
 194 void    start_prompt(UAContext *ua, const char *msg);
 195 void    add_prompt(UAContext *ua, const char *prompt);
 196 int     do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt);
 197 CAT    *get_catalog_resource(UAContext *ua);
 198 STORE  *get_storage_resource(UAContext *ua, bool use_default);
 199 int     get_storage_drive(UAContext *ua, STORE *store);
 200 int     get_media_type(UAContext *ua, char *MediaType, int max_media);
 201 bool    get_pool_dbr(UAContext *ua, POOL_DBR *pr);
 202 int     get_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 203 POOL   *get_pool_resource(UAContext *ua);
 204 POOL   *select_pool_resource(UAContext *ua);
 205 CLIENT *get_client_resource(UAContext *ua);
 206 int     get_job_dbr(UAContext *ua, JOB_DBR *jr);
 207
 208 int find_arg_keyword(UAContext *ua, const char **list);
 209 int find_arg(UAContext *ua, const char *keyword);
 210 int find_arg_with_value(UAContext *ua, const char *keyword);
 211 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list);
 212 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg);
 213 bool get_level_from_name(JCR *jcr, const char *level_name);
 214
 215 /* ua_tree.c */
 216 bool user_select_files_from_tree(TREE_CTX *tree);
 217 int insert_tree_handler(void *ctx, int num_fields, char **row);
 218
 219 /* ua_prune.c */
 220 int prune_files(UAContext *ua, CLIENT *client);
 221 int prune_jobs(UAContext *ua, CLIENT *client, int JobType);
 222 int prune_volume(UAContext *ua, MEDIA_DBR *mr);
 223
 224 /* ua_purge.c */
 225 bool mark_media_purged(UAContext *ua, MEDIA_DBR *mr);
 226 void purge_files_from_volume(UAContext *ua, MEDIA_DBR *mr );
 227 int purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr);
 228 void purge_files_from_job(UAContext *ua, JOB_DBR *jr);
 229
 230
 231 /* ua_run.c */
 232 extern int run_cmd(UAContext *ua, const char *cmd);
 233
 234 /* verify.c */
 235 extern bool do_verify(JCR *jcr);
 236 extern bool do_verify_init(JCR *jcr);
 237 extern void verify_cleanup(JCR *jcr, int TermCode);