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-2006 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 void 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_runscripts_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 DBId_t get_or_create_pool_record(JCR *jcr, char *pool_name);
  98 extern void apply_pool_overrides(JCR *jcr);
  99 extern JobId_t run_job(JCR *jcr);
 100 extern bool cancel_job(UAContext *ua, JCR *jcr);
 101 extern void init_jcr_job_record(JCR *jcr);
 102 extern void copy_rwstorage(JCR *jcr, alist *storage, const char *where);
 103 extern void set_rwstorage(JCR *jcr, STORE *store);
 104 extern void free_rwstorage(JCR *jcr);
 105 extern void copy_wstorage(JCR *jcr, alist *storage, const char *where);
 106 extern void set_wstorage(JCR *jcr, STORE *store);
 107 extern void free_wstorage(JCR *jcr);
 108 extern void copy_rstorage(JCR *jcr, alist *storage, const char *where);
 109 extern void set_rstorage(JCR *jcr, STORE *store);
 110 extern void free_rstorage(JCR *jcr);
 111 extern bool setup_job(JCR *jcr);
 112 extern void create_clones(JCR *jcr);
 113 extern bool create_restore_bootstrap_file(JCR *jcr);
 114
 115 /* migration.c */
 116 extern bool do_migration(JCR *jcr);
 117 extern bool do_migration_init(JCR *jcr);
 118 extern void migration_cleanup(JCR *jcr, int TermCode);
 119
 120
 121 /* mountreq.c */
 122 extern void mount_request(JCR *jcr, BSOCK *bs, char *buf);
 123
 124 /* msgchan.c */
 125 extern bool connect_to_storage_daemon(JCR *jcr, int retry_interval,
 126                               int max_retry_time, int verbose);
 127 extern bool start_storage_daemon_job(JCR *jcr, alist *rstore, alist *wstore);
 128 extern int start_storage_daemon_message_thread(JCR *jcr);
 129 extern int bget_dirmsg(BSOCK *bs);
 130 extern void wait_for_storage_daemon_termination(JCR *jcr);
 131
 132 /* next_vol.c */
 133 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, int index, bool create);
 134 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr);
 135 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason);
 136
 137 /* newvol.c */
 138 bool newVolume(JCR *jcr, MEDIA_DBR *mr);
 139
 140 /* python.c */
 141 int generate_job_event(JCR *jcr, const char *event);
 142
 143
 144 /* restore.c */
 145 extern bool do_restore(JCR *jcr);
 146 extern bool do_restore_init(JCR *jcr);
 147 extern void restore_cleanup(JCR *jcr, int TermCode);
 148
 149
 150 /* ua_acl.c */
 151 bool acl_access_ok(UAContext *ua, int acl, char *item);
 152 bool acl_access_ok(UAContext *ua, int acl, char *item, int len);
 153
 154 /* ua_cmds.c */
 155 int do_a_command(UAContext *ua, const char *cmd);
 156 int do_a_dot_command(UAContext *ua, const char *cmd);
 157 int qmessagescmd(UAContext *ua, const char *cmd);
 158 bool open_db(UAContext *ua);
 159 void close_db(UAContext *ua);
 160 enum e_pool_op {
 161    POOL_OP_UPDATE,
 162    POOL_OP_CREATE
 163 };
 164 int create_pool(JCR *jcr, B_DB *db, POOL *pool, e_pool_op op);
 165 void set_pool_dbr_defaults_in_media_dbr(MEDIA_DBR *mr, POOL_DBR *pr);
 166 void set_pooldbr_from_poolres(POOL_DBR *pr, POOL *pool, e_pool_op op);
 167
 168 /* ua_input.c */
 169 int get_cmd(UAContext *ua, const char *prompt);
 170 bool get_pint(UAContext *ua, const char *prompt);
 171 bool get_yesno(UAContext *ua, const char *prompt);
 172 void parse_ua_args(UAContext *ua);
 173
 174 /* ua_label.c */
 175 bool is_volume_name_legal(UAContext *ua, const char *name);
 176 int get_num_drives_from_SD(UAContext *ua);
 177
 178 /* ua_output.c */
 179 void prtit(void *ctx, const char *msg);
 180 int complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool);
 181 RUN *find_next_run(RUN *run, JOB *job, time_t &runtime, int ndays);
 182
 183 /* ua_restore.c */
 184 int get_next_jobid_from_list(char **p, JobId_t *JobId);
 185 void find_storage_resource(UAContext *ua, RESTORE_CTX &rx, char *Storage, char *MediaType);
 186
 187 /* ua_server.c */
 188 void bsendmsg(void *sock, const char *fmt, ...);
 189 UAContext *new_ua_context(JCR *jcr);
 190 JCR *new_control_jcr(const char *base_name, int job_type);
 191 void free_ua_context(UAContext *ua);
 192
 193 /* ua_select.c */
 194 STORE   *select_storage_resource(UAContext *ua);
 195 JOB     *select_job_resource(UAContext *ua);
 196 JOB     *select_restore_job_resource(UAContext *ua);
 197 CLIENT  *select_client_resource(UAContext *ua);
 198 FILESET *select_fileset_resource(UAContext *ua);
 199 int     select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr);
 200 int     select_media_dbr(UAContext *ua, MEDIA_DBR *mr);
 201 bool    select_pool_dbr(UAContext *ua, POOL_DBR *pr);
 202 int     select_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 203
 204 void    start_prompt(UAContext *ua, const char *msg);
 205 void    add_prompt(UAContext *ua, const char *prompt);
 206 int     do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt);
 207 CAT    *get_catalog_resource(UAContext *ua);
 208 STORE  *get_storage_resource(UAContext *ua, bool use_default);
 209 int     get_storage_drive(UAContext *ua, STORE *store);
 210 int     get_media_type(UAContext *ua, char *MediaType, int max_media);
 211 bool    get_pool_dbr(UAContext *ua, POOL_DBR *pr);
 212 int     get_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 213 POOL   *get_pool_resource(UAContext *ua);
 214 POOL   *select_pool_resource(UAContext *ua);
 215 CLIENT *get_client_resource(UAContext *ua);
 216 int     get_job_dbr(UAContext *ua, JOB_DBR *jr);
 217
 218 int find_arg_keyword(UAContext *ua, const char **list);
 219 int find_arg(UAContext *ua, const char *keyword);
 220 int find_arg_with_value(UAContext *ua, const char *keyword);
 221 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list);
 222 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg);
 223 bool get_level_from_name(JCR *jcr, const char *level_name);
 224
 225 /* ua_tree.c */
 226 bool user_select_files_from_tree(TREE_CTX *tree);
 227 int insert_tree_handler(void *ctx, int num_fields, char **row);
 228
 229 /* ua_prune.c */
 230 int prune_files(UAContext *ua, CLIENT *client);
 231 int prune_jobs(UAContext *ua, CLIENT *client, int JobType);
 232 bool prune_volume(UAContext *ua, MEDIA_DBR *mr);
 233
 234 /* ua_purge.c */
 235 bool mark_media_purged(UAContext *ua, MEDIA_DBR *mr);
 236 void purge_files_from_volume(UAContext *ua, MEDIA_DBR *mr );
 237 int purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr);
 238 void purge_files_from_job(UAContext *ua, JobId_t JobId);
 239 void purge_job_from_catalog(UAContext *ua, JobId_t JobId);
 240
 241
 242 /* ua_run.c */
 243 extern int run_cmd(UAContext *ua, const char *cmd);
 244
 245 /* verify.c */
 246 extern bool do_verify(JCR *jcr);
 247 extern bool do_verify_init(JCR *jcr);
 248 extern void verify_cleanup(JCR *jcr, int TermCode);