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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2010 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 three of the GNU Affero 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 Affero 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
  32 /* admin.c */
  33 extern bool do_admin_init(JCR *jcr);
  34 extern bool do_admin(JCR *jcr);
  35 extern void admin_cleanup(JCR *jcr, int TermCode);
  36
  37
  38 /* authenticate.c */
  39 extern bool authenticate_storage_daemon(JCR *jcr, STORE *store);
  40 extern int authenticate_file_daemon(JCR *jcr);
  41 extern int authenticate_user_agent(UAContext *ua);
  42
  43 /* autoprune.c */
  44 extern void do_autoprune(JCR *jcr);
  45 extern void prune_volumes(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  46
  47 /* autorecycle.c */
  48 extern bool recycle_oldest_purged_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  49 extern int recycle_volume(JCR *jcr, MEDIA_DBR *mr);
  50 extern bool find_recycled_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  51
  52 /* backup.c */
  53 extern int wait_for_job_termination(JCR *jcr, int timeout=0);
  54 extern bool do_backup_init(JCR *jcr);
  55 extern bool do_backup(JCR *jcr);
  56 extern void backup_cleanup(JCR *jcr, int TermCode);
  57 extern void update_bootstrap_file(JCR *jcr);
  58 extern bool send_accurate_current_files(JCR *jcr);
  59
  60
  61 /* vbackup.c */
  62 extern bool do_vbackup_init(JCR *jcr);
  63 extern bool do_vbackup(JCR *jcr);
  64 extern void vbackup_cleanup(JCR *jcr, int TermCode);
  65
  66
  67 /* bsr.c */
  68 RBSR *new_bsr();
  69 void free_bsr(RBSR *bsr);
  70 bool complete_bsr(UAContext *ua, RBSR *bsr);
  71 uint32_t write_bsr_file(UAContext *ua, RESTORE_CTX &rx);
  72 void display_bsr_info(UAContext *ua, RESTORE_CTX &rx);
  73 void add_findex(RBSR *bsr, uint32_t JobId, int32_t findex);
  74 void add_findex_all(RBSR *bsr, uint32_t JobId);
  75 RBSR_FINDEX *new_findex();
  76 void make_unique_restore_filename(UAContext *ua, POOLMEM **fname);
  77 void print_bsr(UAContext *ua, RESTORE_CTX &rx);
  78
  79
  80 /* catreq.c */
  81 extern void catalog_request(JCR *jcr, BSOCK *bs);
  82 extern void catalog_update(JCR *jcr, BSOCK *bs);
  83 extern bool despool_attributes_from_file(JCR *jcr, const char *file);
  84
  85 /* dird_conf.c */
  86 extern const char *level_to_str(int level);
  87 extern "C" char *job_code_callback_director(JCR *jcr, const char*);
  88
  89 /* expand.c */
  90 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp);
  91
  92
  93 /* fd_cmds.c */
  94 extern int connect_to_file_daemon(JCR *jcr, int retry_interval,
  95                                   int max_retry_time, int verbose);
  96 extern bool send_include_list(JCR *jcr);
  97 extern bool send_exclude_list(JCR *jcr);
  98 extern bool send_level_command(JCR *jcr);
  99 extern int get_attributes_and_put_in_catalog(JCR *jcr);
 100 extern void get_attributes_and_compare_to_catalog(JCR *jcr, JobId_t JobId);
 101 extern int put_file_into_catalog(JCR *jcr, long file_index, char *fname,
 102                           char *link, char *attr, int stream);
 103 extern void get_level_since_time(JCR *jcr, char *since, int since_len);
 104 extern int send_runscripts_commands(JCR *jcr);
 105 extern bool send_restore_objects(JCR *jcr);
 106
 107 /* getmsg.c */
 108 enum e_prtmsg {
 109    DISPLAY_ERROR,
 110    NO_DISPLAY
 111 };
 112 extern bool response(JCR *jcr, BSOCK *fd, char *resp, const char *cmd, e_prtmsg prtmsg);
 113
 114 /* job.c */
 115 extern bool allow_duplicate_job(JCR *jcr);
 116 extern void set_jcr_defaults(JCR *jcr, JOB *job);
 117 extern void create_unique_job_name(JCR *jcr, const char *base_name);
 118 extern void update_job_end_record(JCR *jcr);
 119 extern bool get_or_create_client_record(JCR *jcr);
 120 extern bool get_or_create_fileset_record(JCR *jcr);
 121 extern DBId_t get_or_create_pool_record(JCR *jcr, char *pool_name);
 122 extern void apply_pool_overrides(JCR *jcr);
 123 extern JobId_t run_job(JCR *jcr);
 124 extern bool cancel_job(UAContext *ua, JCR *jcr);
 125 extern void get_job_storage(USTORE *store, JOB *job, RUN *run);
 126 extern void init_jcr_job_record(JCR *jcr);
 127 extern void update_job_end(JCR *jcr, int TermCode);
 128 extern void copy_rwstorage(JCR *jcr, alist *storage, const char *where);
 129 extern void set_rwstorage(JCR *jcr, USTORE *store);
 130 extern void free_rwstorage(JCR *jcr);
 131 extern void copy_wstorage(JCR *jcr, alist *storage, const char *where);
 132 extern void set_wstorage(JCR *jcr, USTORE *store);
 133 extern void free_wstorage(JCR *jcr);
 134 extern void copy_rstorage(JCR *jcr, alist *storage, const char *where);
 135 extern void set_rstorage(JCR *jcr, USTORE *store);
 136 extern void free_rstorage(JCR *jcr);
 137 extern bool setup_job(JCR *jcr);
 138 extern void create_clones(JCR *jcr);
 139 extern int create_restore_bootstrap_file(JCR *jcr);
 140 extern void dird_free_jcr(JCR *jcr);
 141 extern void dird_free_jcr_pointers(JCR *jcr);
 142 extern void cancel_storage_daemon_job(JCR *jcr);
 143 extern bool run_console_command(JCR *jcr, const char *cmd);
 144 extern void sd_msg_thread_send_signal(JCR *jcr, int sig);
 145
 146 /* jobq.c */
 147 extern bool inc_read_store(JCR *jcr);
 148 extern void dec_read_store(JCR *jcr);
 149
 150 /* migration.c */
 151 extern bool do_migration(JCR *jcr);
 152 extern bool do_migration_init(JCR *jcr);
 153 extern void migration_cleanup(JCR *jcr, int TermCode);
 154 extern bool set_migration_wstorage(JCR *jcr, POOL *pool);
 155
 156
 157 /* mountreq.c */
 158 extern void mount_request(JCR *jcr, BSOCK *bs, char *buf);
 159
 160 /* msgchan.c */
 161 extern bool connect_to_storage_daemon(JCR *jcr, int retry_interval,
 162                               int max_retry_time, int verbose);
 163 extern bool start_storage_daemon_job(JCR *jcr, alist *rstore, alist *wstore,
 164               bool send_bsr=false);
 165 extern bool start_storage_daemon_message_thread(JCR *jcr);
 166 extern int bget_dirmsg(BSOCK *bs);
 167 extern void wait_for_storage_daemon_termination(JCR *jcr);
 168 extern bool send_bootstrap_file(JCR *jcr, BSOCK *sd);
 169
 170 /* next_vol.c */
 171 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, int index,
 172                                 bool create, bool purge);
 173 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr);
 174 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason);
 175 bool get_scratch_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
 176
 177 /* newvol.c */
 178 bool newVolume(JCR *jcr, MEDIA_DBR *mr);
 179
 180 /* python.c */
 181 int generate_job_event(JCR *jcr, const char *event);
 182
 183
 184 /* restore.c */
 185 extern bool do_restore(JCR *jcr);
 186 extern bool do_restore_init(JCR *jcr);
 187 extern void restore_cleanup(JCR *jcr, int TermCode);
 188
 189
 190 /* ua_acl.c */
 191 bool acl_access_ok(UAContext *ua, int acl, const char *item);
 192 bool acl_access_ok(UAContext *ua, int acl, const char *item, int len);
 193
 194 /* ua_cmds.c */
 195 bool do_a_command(UAContext *ua);
 196 bool do_a_dot_command(UAContext *ua);
 197 int qmessagescmd(UAContext *ua, const char *cmd);
 198 bool open_new_client_db(UAContext *ua);
 199 bool open_client_db(UAContext *ua);
 200 bool open_db(UAContext *ua);
 201 void close_db(UAContext *ua);
 202 enum e_pool_op {
 203    POOL_OP_UPDATE,
 204    POOL_OP_CREATE
 205 };
 206 int create_pool(JCR *jcr, B_DB *db, POOL *pool, e_pool_op op);
 207 void set_pool_dbr_defaults_in_media_dbr(MEDIA_DBR *mr, POOL_DBR *pr);
 208 bool set_pooldbr_references(JCR *jcr, B_DB *db, POOL_DBR *pr, POOL *pool);
 209 void set_pooldbr_from_poolres(POOL_DBR *pr, POOL *pool, e_pool_op op);
 210 int update_pool_references(JCR *jcr, B_DB *db, POOL *pool);
 211
 212 /* ua_input.c */
 213 int get_cmd(UAContext *ua, const char *prompt, bool subprompt=false);
 214 bool get_pint(UAContext *ua, const char *prompt);
 215 bool get_yesno(UAContext *ua, const char *prompt);
 216 bool is_yesno(char *val, int *ret);
 217 int get_enabled(UAContext *ua, const char *val);
 218 void parse_ua_args(UAContext *ua);
 219 bool is_comment_legal(UAContext *ua, const char *name);
 220
 221 /* ua_label.c */
 222 bool is_volume_name_legal(UAContext *ua, const char *name);
 223 int get_num_drives_from_SD(UAContext *ua);
 224 void update_slots(UAContext *ua);
 225
 226 /* ua_update.c */
 227 void update_vol_pool(UAContext *ua, char *val, MEDIA_DBR *mr, POOL_DBR *opr);
 228
 229 /* ua_output.c */
 230 void prtit(void *ctx, const char *msg);
 231 bool complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool);
 232 RUN *find_next_run(RUN *run, JOB *job, utime_t &runtime, int ndays);
 233
 234 /* ua_restore.c */
 235 void find_storage_resource(UAContext *ua, RESTORE_CTX &rx, char *Storage, char *MediaType);
 236
 237 /* ua_server.c */
 238 void bsendmsg(void *ua_ctx, const char *fmt, ...);
 239 void berrormsg(void *ua_ctx, const char *fmt, ...);
 240 void bwarningmsg(void *ua_ctx, const char *fmt, ...);
 241 void binfomsg(void *ua_ctx, const char *fmt, ...);
 242 UAContext *new_ua_context(JCR *jcr);
 243 JCR *new_control_jcr(const char *base_name, int job_type);
 244 void free_ua_context(UAContext *ua);
 245
 246 /* ua_select.c */
 247 STORE   *select_storage_resource(UAContext *ua);
 248 JOB     *select_job_resource(UAContext *ua);
 249 JOB     *select_enable_disable_job_resource(UAContext *ua, bool enable);
 250 JOB     *select_restore_job_resource(UAContext *ua);
 251 CLIENT  *select_client_resource(UAContext *ua);
 252 FILESET *select_fileset_resource(UAContext *ua);
 253 int     select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr);
 254 int     select_media_dbr(UAContext *ua, MEDIA_DBR *mr);
 255 bool    select_pool_dbr(UAContext *ua, POOL_DBR *pr, const char *argk="pool");
 256 bool    select_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 257
 258 void    start_prompt(UAContext *ua, const char *msg);
 259 void    add_prompt(UAContext *ua, const char *prompt);
 260 int     do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt);
 261 CAT    *get_catalog_resource(UAContext *ua);
 262 STORE  *get_storage_resource(UAContext *ua, bool use_default);
 263 int     get_storage_drive(UAContext *ua, STORE *store);
 264 int     get_storage_slot(UAContext *ua, STORE *store);
 265 int     get_media_type(UAContext *ua, char *MediaType, int max_media);
 266 bool    get_pool_dbr(UAContext *ua, POOL_DBR *pr, const char *argk="pool");
 267 bool    get_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 268 POOL   *get_pool_resource(UAContext *ua);
 269 JOB    *get_restore_job(UAContext *ua);
 270 POOL   *select_pool_resource(UAContext *ua);
 271 JCR *select_running_job(UAContext *ua, const char *reason);
 272 CLIENT *get_client_resource(UAContext *ua);
 273 int     get_job_dbr(UAContext *ua, JOB_DBR *jr);
 274
 275 int find_arg_keyword(UAContext *ua, const char **list);
 276 int find_arg(UAContext *ua, const char *keyword);
 277 int find_arg_with_value(UAContext *ua, const char *keyword);
 278 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list);
 279 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg);
 280 bool get_level_from_name(JCR *jcr, const char *level_name);
 281
 282 /* ua_status.c */
 283 void list_dir_status_header(UAContext *ua);
 284
 285 /* ua_tree.c */
 286 bool user_select_files_from_tree(TREE_CTX *tree);
 287 int insert_tree_handler(void *ctx, int num_fields, char **row);
 288
 289 /* ua_prune.c */
 290 int prune_files(UAContext *ua, CLIENT *client, POOL *pool);
 291 int prune_jobs(UAContext *ua, CLIENT *client, POOL *pool, int JobType);
 292 int prune_stats(UAContext *ua, utime_t retention);
 293 bool prune_volume(UAContext *ua, MEDIA_DBR *mr);
 294 int job_delete_handler(void *ctx, int num_fields, char **row);
 295 int del_count_handler(void *ctx, int num_fields, char **row);
 296 int file_delete_handler(void *ctx, int num_fields, char **row);
 297 int get_prune_list_for_volume(UAContext *ua, MEDIA_DBR *mr, del_ctx *del);
 298 int exclude_running_jobs_from_list(del_ctx *prune_list);
 299
 300 /* ua_purge.c */
 301 bool is_volume_purged(UAContext *ua, MEDIA_DBR *mr, bool force=false);
 302 bool mark_media_purged(UAContext *ua, MEDIA_DBR *mr);
 303 void purge_files_from_volume(UAContext *ua, MEDIA_DBR *mr);
 304 bool purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr, bool force=false);
 305 void purge_files_from_jobs(UAContext *ua, char *jobs);
 306 void purge_jobs_from_catalog(UAContext *ua, char *jobs);
 307 void purge_job_list_from_catalog(UAContext *ua, del_ctx &del);
 308 void purge_files_from_job_list(UAContext *ua, del_ctx &del);
 309
 310
 311 /* ua_run.c */
 312 extern int run_cmd(UAContext *ua, const char *cmd);
 313
 314 /* verify.c */
 315 extern bool do_verify(JCR *jcr);
 316 extern bool do_verify_init(JCR *jcr);
 317 extern void verify_cleanup(JCR *jcr, int TermCode);