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