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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of Kern Sibbald.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  * Director external function prototypes
  30  *
  31  *   Version $Id$
  32  */
  33
  34 /* admin.c */
  35 extern bool do_admin_init(JCR *jcr);
  36 extern bool do_admin(JCR *jcr);
  37 extern void admin_cleanup(JCR *jcr, int TermCode);
  38
  39
  40 /* authenticate.c */
  41 extern bool authenticate_storage_daemon(JCR *jcr, STORE *store);
  42 extern int authenticate_file_daemon(JCR *jcr);
  43 extern int authenticate_user_agent(UAContext *ua);
  44
  45 /* autoprune.c */
  46 extern void do_autoprune(JCR *jcr);
  47 extern void prune_volumes(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  48
  49 /* autorecycle.c */
  50 extern bool recycle_oldest_purged_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  51 extern int recycle_volume(JCR *jcr, MEDIA_DBR *mr);
  52 extern bool find_recycled_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  53
  54 /* backup.c */
  55 extern int wait_for_job_termination(JCR *jcr, int timeout=0);
  56 extern bool do_backup_init(JCR *jcr);
  57 extern bool do_backup(JCR *jcr);
  58 extern void backup_cleanup(JCR *jcr, int TermCode);
  59 extern void update_bootstrap_file(JCR *jcr);
  60 extern bool send_accurate_current_files(JCR *jcr);
  61
  62
  63 /* vbackup.c */
  64 extern bool do_vbackup_init(JCR *jcr);
  65 extern bool do_vbackup(JCR *jcr);
  66 extern void vbackup_cleanup(JCR *jcr, int TermCode);
  67
  68
  69 /* bsr.c */
  70 RBSR *new_bsr();
  71 void free_bsr(RBSR *bsr);
  72 bool complete_bsr(UAContext *ua, RBSR *bsr);
  73 uint32_t write_bsr_file(UAContext *ua, RESTORE_CTX &rx);
  74 void display_bsr_info(UAContext *ua, RESTORE_CTX &rx);
  75 void add_findex(RBSR *bsr, uint32_t JobId, int32_t findex);
  76 void add_findex_all(RBSR *bsr, uint32_t JobId);
  77 RBSR_FINDEX *new_findex();
  78 void make_unique_restore_filename(UAContext *ua, POOLMEM **fname);
  79 void print_bsr(UAContext *ua, RESTORE_CTX &rx);
  80
  81
  82 /* catreq.c */
  83 extern void catalog_request(JCR *jcr, BSOCK *bs);
  84 extern void catalog_update(JCR *jcr, BSOCK *bs);
  85 extern bool despool_attributes_from_file(JCR *jcr, const char *file);
  86
  87 /* dird_conf.c */
  88 extern const char *level_to_str(int level);
  89 extern "C" char *job_code_callback_filesetname(JCR *jcr, const char*);
  90
  91 /* expand.c */
  92 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp);
  93
  94
  95 /* fd_cmds.c */
  96 extern int connect_to_file_daemon(JCR *jcr, int retry_interval,
  97                                   int max_retry_time, int verbose);
  98 extern bool send_include_list(JCR *jcr);
  99 extern bool send_exclude_list(JCR *jcr);
 100 extern bool send_bootstrap_file(JCR *jcr, BSOCK *sock);
 101 extern bool send_level_command(JCR *jcr);
 102 extern int get_attributes_and_put_in_catalog(JCR *jcr);
 103 extern void get_attributes_and_compare_to_catalog(JCR *jcr, JobId_t JobId);
 104 extern int put_file_into_catalog(JCR *jcr, long file_index, char *fname,
 105                           char *link, char *attr, int stream);
 106 extern void get_level_since_time(JCR *jcr, char *since, int since_len);
 107 extern int send_runscripts_commands(JCR *jcr);
 108
 109 /* getmsg.c */
 110 enum e_prtmsg {
 111    DISPLAY_ERROR,
 112    NO_DISPLAY
 113 };
 114 extern bool response(JCR *jcr, BSOCK *fd, char *resp, const char *cmd, e_prtmsg prtmsg);
 115
 116 /* job.c */
 117 extern bool allow_duplicate_job(JCR *jcr);
 118 extern void set_jcr_defaults(JCR *jcr, JOB *job);
 119 extern void create_unique_job_name(JCR *jcr, const char *base_name);
 120 extern void update_job_end_record(JCR *jcr);
 121 extern bool get_or_create_client_record(JCR *jcr);
 122 extern bool get_or_create_fileset_record(JCR *jcr);
 123 extern DBId_t get_or_create_pool_record(JCR *jcr, char *pool_name);
 124 extern void apply_pool_overrides(JCR *jcr);
 125 extern JobId_t run_job(JCR *jcr);
 126 extern bool cancel_job(UAContext *ua, JCR *jcr);
 127 extern void get_job_storage(USTORE *store, JOB *job, RUN *run);
 128 extern void init_jcr_job_record(JCR *jcr);
 129 extern void update_job_end(JCR *jcr, int TermCode);
 130 extern void copy_rwstorage(JCR *jcr, alist *storage, const char *where);
 131 extern void set_rwstorage(JCR *jcr, USTORE *store);
 132 extern void free_rwstorage(JCR *jcr);
 133 extern void copy_wstorage(JCR *jcr, alist *storage, const char *where);
 134 extern void set_wstorage(JCR *jcr, USTORE *store);
 135 extern void free_wstorage(JCR *jcr);
 136 extern void copy_rstorage(JCR *jcr, alist *storage, const char *where);
 137 extern void set_rstorage(JCR *jcr, USTORE *store);
 138 extern void free_rstorage(JCR *jcr);
 139 extern bool setup_job(JCR *jcr);
 140 extern void create_clones(JCR *jcr);
 141 extern bool create_restore_bootstrap_file(JCR *jcr);
 142 extern void dird_free_jcr(JCR *jcr);
 143 extern void dird_free_jcr_pointers(JCR *jcr);
 144 extern void cancel_storage_daemon_job(JCR *jcr);
 145 extern bool run_console_command(JCR *jcr, const char *cmd);
 146
 147 /* migration.c */
 148 extern bool do_migration(JCR *jcr);
 149 extern bool do_migration_init(JCR *jcr);
 150 extern void migration_cleanup(JCR *jcr, int TermCode);
 151 extern bool set_migration_wstorage(JCR *jcr, POOL *pool);
 152
 153
 154 /* mountreq.c */
 155 extern void mount_request(JCR *jcr, BSOCK *bs, char *buf);
 156
 157 /* msgchan.c */
 158 extern bool connect_to_storage_daemon(JCR *jcr, int retry_interval,
 159                               int max_retry_time, int verbose);
 160 extern bool start_storage_daemon_job(JCR *jcr, alist *rstore, alist *wstore,
 161               bool send_bsr=false);
 162 extern bool start_storage_daemon_message_thread(JCR *jcr);
 163 extern int bget_dirmsg(BSOCK *bs);
 164 extern void wait_for_storage_daemon_termination(JCR *jcr);
 165
 166 /* next_vol.c */
 167 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, int index,
 168                                 bool create, bool purge);
 169 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr);
 170 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason);
 171 bool get_scratch_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
 172
 173 /* newvol.c */
 174 bool newVolume(JCR *jcr, MEDIA_DBR *mr);
 175
 176 /* python.c */
 177 int generate_job_event(JCR *jcr, const char *event);
 178
 179
 180 /* restore.c */
 181 extern bool do_restore(JCR *jcr);
 182 extern bool do_restore_init(JCR *jcr);
 183 extern void restore_cleanup(JCR *jcr, int TermCode);
 184
 185
 186 /* ua_acl.c */
 187 bool acl_access_ok(UAContext *ua, int acl, const char *item);
 188 bool acl_access_ok(UAContext *ua, int acl, const char *item, int len);
 189
 190 /* ua_cmds.c */
 191 bool do_a_command(UAContext *ua);
 192 bool do_a_dot_command(UAContext *ua);
 193 int qmessagescmd(UAContext *ua, const char *cmd);
 194 bool open_client_db(UAContext *ua);
 195 bool open_db(UAContext *ua);
 196 void close_db(UAContext *ua);
 197 enum e_pool_op {
 198    POOL_OP_UPDATE,
 199    POOL_OP_CREATE
 200 };
 201 int create_pool(JCR *jcr, B_DB *db, POOL *pool, e_pool_op op);
 202 void set_pool_dbr_defaults_in_media_dbr(MEDIA_DBR *mr, POOL_DBR *pr);
 203 bool set_pooldbr_references(JCR *jcr, B_DB *db, POOL_DBR *pr, POOL *pool);
 204 void set_pooldbr_from_poolres(POOL_DBR *pr, POOL *pool, e_pool_op op);
 205 int update_pool_references(JCR *jcr, B_DB *db, POOL *pool);
 206
 207 /* ua_input.c */
 208 int get_cmd(UAContext *ua, const char *prompt);
 209 bool get_pint(UAContext *ua, const char *prompt);
 210 bool get_yesno(UAContext *ua, const char *prompt);
 211 bool is_yesno(char *val, int *ret);
 212 int get_enabled(UAContext *ua, const char *val);
 213 void parse_ua_args(UAContext *ua);
 214
 215 /* ua_label.c */
 216 bool is_volume_name_legal(UAContext *ua, const char *name);
 217 int get_num_drives_from_SD(UAContext *ua);
 218 void update_slots(UAContext *ua);
 219
 220 /* ua_update.c */
 221 void update_vol_pool(UAContext *ua, char *val, MEDIA_DBR *mr, POOL_DBR *opr);
 222
 223 /* ua_output.c */
 224 void prtit(void *ctx, const char *msg);
 225 bool complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool);
 226 RUN *find_next_run(RUN *run, JOB *job, utime_t &runtime, int ndays);
 227
 228 /* ua_restore.c */
 229 int get_next_jobid_from_list(char **p, JobId_t *JobId);
 230 void find_storage_resource(UAContext *ua, RESTORE_CTX &rx, char *Storage, char *MediaType);
 231
 232 /* ua_server.c */
 233 void bsendmsg(void *ua_ctx, const char *fmt, ...);
 234 void berrormsg(void *ua_ctx, const char *fmt, ...);
 235 void bwarningmsg(void *ua_ctx, const char *fmt, ...);
 236 void binfomsg(void *ua_ctx, const char *fmt, ...);
 237 UAContext *new_ua_context(JCR *jcr);
 238 JCR *new_control_jcr(const char *base_name, int job_type);
 239 void free_ua_context(UAContext *ua);
 240
 241 /* ua_select.c */
 242 STORE   *select_storage_resource(UAContext *ua);
 243 JOB     *select_job_resource(UAContext *ua);
 244 JOB     *select_restore_job_resource(UAContext *ua);
 245 CLIENT  *select_client_resource(UAContext *ua);
 246 FILESET *select_fileset_resource(UAContext *ua);
 247 int     select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr);
 248 int     select_media_dbr(UAContext *ua, MEDIA_DBR *mr);
 249 bool    select_pool_dbr(UAContext *ua, POOL_DBR *pr, const char *argk="pool");
 250 bool    select_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 251
 252 void    start_prompt(UAContext *ua, const char *msg);
 253 void    add_prompt(UAContext *ua, const char *prompt);
 254 int     do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt);
 255 CAT    *get_catalog_resource(UAContext *ua);
 256 STORE  *get_storage_resource(UAContext *ua, bool use_default);
 257 int     get_storage_drive(UAContext *ua, STORE *store);
 258 int     get_storage_slot(UAContext *ua, STORE *store);
 259 int     get_media_type(UAContext *ua, char *MediaType, int max_media);
 260 bool    get_pool_dbr(UAContext *ua, POOL_DBR *pr, const char *argk="pool");
 261 bool    get_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 262 POOL   *get_pool_resource(UAContext *ua);
 263 POOL   *select_pool_resource(UAContext *ua);
 264 CLIENT *get_client_resource(UAContext *ua);
 265 int     get_job_dbr(UAContext *ua, JOB_DBR *jr);
 266
 267 int find_arg_keyword(UAContext *ua, const char **list);
 268 int find_arg(UAContext *ua, const char *keyword);
 269 int find_arg_with_value(UAContext *ua, const char *keyword);
 270 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list);
 271 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg);
 272 bool get_level_from_name(JCR *jcr, const char *level_name);
 273
 274 /* ua_status.c */
 275 void list_dir_status_header(UAContext *ua);
 276
 277 /* ua_tree.c */
 278 bool user_select_files_from_tree(TREE_CTX *tree);
 279 int insert_tree_handler(void *ctx, int num_fields, char **row);
 280
 281 /* ua_prune.c */
 282 int prune_files(UAContext *ua, CLIENT *client);
 283 int prune_jobs(UAContext *ua, CLIENT *client, int JobType);
 284 int prune_stats(UAContext *ua, utime_t retention);
 285 bool prune_volume(UAContext *ua, MEDIA_DBR *mr);
 286 int job_delete_handler(void *ctx, int num_fields, char **row);
 287 int del_count_handler(void *ctx, int num_fields, char **row);
 288 int file_delete_handler(void *ctx, int num_fields, char **row);
 289 int get_prune_list_for_volume(UAContext *ua, MEDIA_DBR *mr, del_ctx *del);
 290 int exclude_running_jobs_from_list(del_ctx *prune_list);
 291
 292 /* ua_purge.c */
 293 bool is_volume_purged(UAContext *ua, MEDIA_DBR *mr, bool force=false);
 294 bool mark_media_purged(UAContext *ua, MEDIA_DBR *mr);
 295 void purge_files_from_volume(UAContext *ua, MEDIA_DBR *mr);
 296 bool purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr, bool force=false);
 297 void purge_files_from_jobs(UAContext *ua, char *jobs);
 298 void purge_jobs_from_catalog(UAContext *ua, char *jobs);
 299 void purge_job_list_from_catalog(UAContext *ua, del_ctx &del);
 300 void purge_files_from_job_list(UAContext *ua, del_ctx &del);
 301
 302
 303 /* ua_run.c */
 304 extern int run_cmd(UAContext *ua, const char *cmd);
 305
 306 /* verify.c */
 307 extern bool do_verify(JCR *jcr);
 308 extern bool do_verify_init(JCR *jcr);
 309 extern void verify_cleanup(JCR *jcr, int TermCode);