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_level_command(JCR *jcr);
 101 extern int get_attributes_and_put_in_catalog(JCR *jcr);
 102 extern void get_attributes_and_compare_to_catalog(JCR *jcr, JobId_t JobId);
 103 extern int put_file_into_catalog(JCR *jcr, long file_index, char *fname,
 104                           char *link, char *attr, int stream);
 105 extern void get_level_since_time(JCR *jcr, char *since, int since_len);
 106 extern int send_runscripts_commands(JCR *jcr);
 107
 108 /* getmsg.c */
 109 enum e_prtmsg {
 110    DISPLAY_ERROR,
 111    NO_DISPLAY
 112 };
 113 extern bool response(JCR *jcr, BSOCK *fd, char *resp, const char *cmd, e_prtmsg prtmsg);
 114
 115 /* job.c */
 116 extern bool allow_duplicate_job(JCR *jcr);
 117 extern void set_jcr_defaults(JCR *jcr, JOB *job);
 118 extern void create_unique_job_name(JCR *jcr, const char *base_name);
 119 extern void update_job_end_record(JCR *jcr);
 120 extern bool get_or_create_client_record(JCR *jcr);
 121 extern bool get_or_create_fileset_record(JCR *jcr);
 122 extern DBId_t get_or_create_pool_record(JCR *jcr, char *pool_name);
 123 extern void apply_pool_overrides(JCR *jcr);
 124 extern JobId_t run_job(JCR *jcr);
 125 extern bool cancel_job(UAContext *ua, JCR *jcr);
 126 extern void get_job_storage(USTORE *store, JOB *job, RUN *run);
 127 extern void init_jcr_job_record(JCR *jcr);
 128 extern void update_job_end(JCR *jcr, int TermCode);
 129 extern void copy_rwstorage(JCR *jcr, alist *storage, const char *where);
 130 extern void set_rwstorage(JCR *jcr, USTORE *store);
 131 extern void free_rwstorage(JCR *jcr);
 132 extern void copy_wstorage(JCR *jcr, alist *storage, const char *where);
 133 extern void set_wstorage(JCR *jcr, USTORE *store);
 134 extern void free_wstorage(JCR *jcr);
 135 extern void copy_rstorage(JCR *jcr, alist *storage, const char *where);
 136 extern void set_rstorage(JCR *jcr, USTORE *store);
 137 extern void free_rstorage(JCR *jcr);
 138 extern bool setup_job(JCR *jcr);
 139 extern void create_clones(JCR *jcr);
 140 extern int create_restore_bootstrap_file(JCR *jcr);
 141 extern void dird_free_jcr(JCR *jcr);
 142 extern void dird_free_jcr_pointers(JCR *jcr);
 143 extern void cancel_storage_daemon_job(JCR *jcr);
 144 extern bool run_console_command(JCR *jcr, const char *cmd);
 145 extern void sd_msg_thread_send_signal(JCR *jcr, int sig);
 146
 147 /* jobq.c */
 148 extern bool inc_read_store(JCR *jcr);
 149 extern void dec_read_store(JCR *jcr);
 150
 151 /* migration.c */
 152 extern bool do_migration(JCR *jcr);
 153 extern bool do_migration_init(JCR *jcr);
 154 extern void migration_cleanup(JCR *jcr, int TermCode);
 155 extern bool set_migration_wstorage(JCR *jcr, POOL *pool);
 156
 157
 158 /* mountreq.c */
 159 extern void mount_request(JCR *jcr, BSOCK *bs, char *buf);
 160
 161 /* msgchan.c */
 162 extern bool connect_to_storage_daemon(JCR *jcr, int retry_interval,
 163                               int max_retry_time, int verbose);
 164 extern bool start_storage_daemon_job(JCR *jcr, alist *rstore, alist *wstore,
 165               bool send_bsr=false);
 166 extern bool start_storage_daemon_message_thread(JCR *jcr);
 167 extern int bget_dirmsg(BSOCK *bs);
 168 extern void wait_for_storage_daemon_termination(JCR *jcr);
 169 extern bool send_bootstrap_file(JCR *jcr, BSOCK *sd);
 170
 171 /* next_vol.c */
 172 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, int index,
 173                                 bool create, bool purge);
 174 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr);
 175 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason);
 176 bool get_scratch_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
 177
 178 /* newvol.c */
 179 bool newVolume(JCR *jcr, MEDIA_DBR *mr);
 180
 181 /* python.c */
 182 int generate_job_event(JCR *jcr, const char *event);
 183
 184
 185 /* restore.c */
 186 extern bool do_restore(JCR *jcr);
 187 extern bool do_restore_init(JCR *jcr);
 188 extern void restore_cleanup(JCR *jcr, int TermCode);
 189
 190
 191 /* ua_acl.c */
 192 bool acl_access_ok(UAContext *ua, int acl, const char *item);
 193 bool acl_access_ok(UAContext *ua, int acl, const char *item, int len);
 194
 195 /* ua_cmds.c */
 196 bool do_a_command(UAContext *ua);
 197 bool do_a_dot_command(UAContext *ua);
 198 int qmessagescmd(UAContext *ua, const char *cmd);
 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);
 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
 220 /* ua_label.c */
 221 bool is_volume_name_legal(UAContext *ua, const char *name);
 222 int get_num_drives_from_SD(UAContext *ua);
 223 void update_slots(UAContext *ua);
 224
 225 /* ua_update.c */
 226 void update_vol_pool(UAContext *ua, char *val, MEDIA_DBR *mr, POOL_DBR *opr);
 227
 228 /* ua_output.c */
 229 void prtit(void *ctx, const char *msg);
 230 bool complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool);
 231 RUN *find_next_run(RUN *run, JOB *job, utime_t &runtime, int ndays);
 232
 233 /* ua_restore.c */
 234 void find_storage_resource(UAContext *ua, RESTORE_CTX &rx, char *Storage, char *MediaType);
 235
 236 /* ua_server.c */
 237 void bsendmsg(void *ua_ctx, const char *fmt, ...);
 238 void berrormsg(void *ua_ctx, const char *fmt, ...);
 239 void bwarningmsg(void *ua_ctx, const char *fmt, ...);
 240 void binfomsg(void *ua_ctx, const char *fmt, ...);
 241 UAContext *new_ua_context(JCR *jcr);
 242 JCR *new_control_jcr(const char *base_name, int job_type);
 243 void free_ua_context(UAContext *ua);
 244
 245 /* ua_select.c */
 246 STORE   *select_storage_resource(UAContext *ua);
 247 JOB     *select_job_resource(UAContext *ua);
 248 JOB     *select_enable_disable_job_resource(UAContext *ua, bool enable);
 249 JOB     *select_restore_job_resource(UAContext *ua);
 250 CLIENT  *select_client_resource(UAContext *ua);
 251 FILESET *select_fileset_resource(UAContext *ua);
 252 int     select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr);
 253 int     select_media_dbr(UAContext *ua, MEDIA_DBR *mr);
 254 bool    select_pool_dbr(UAContext *ua, POOL_DBR *pr, const char *argk="pool");
 255 bool    select_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 256
 257 void    start_prompt(UAContext *ua, const char *msg);
 258 void    add_prompt(UAContext *ua, const char *prompt);
 259 int     do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt);
 260 CAT    *get_catalog_resource(UAContext *ua);
 261 STORE  *get_storage_resource(UAContext *ua, bool use_default);
 262 int     get_storage_drive(UAContext *ua, STORE *store);
 263 int     get_storage_slot(UAContext *ua, STORE *store);
 264 int     get_media_type(UAContext *ua, char *MediaType, int max_media);
 265 bool    get_pool_dbr(UAContext *ua, POOL_DBR *pr, const char *argk="pool");
 266 bool    get_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 267 POOL   *get_pool_resource(UAContext *ua);
 268 POOL   *select_pool_resource(UAContext *ua);
 269 CLIENT *get_client_resource(UAContext *ua);
 270 int     get_job_dbr(UAContext *ua, JOB_DBR *jr);
 271
 272 int find_arg_keyword(UAContext *ua, const char **list);
 273 int find_arg(UAContext *ua, const char *keyword);
 274 int find_arg_with_value(UAContext *ua, const char *keyword);
 275 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list);
 276 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg);
 277 bool get_level_from_name(JCR *jcr, const char *level_name);
 278
 279 /* ua_status.c */
 280 void list_dir_status_header(UAContext *ua);
 281
 282 /* ua_tree.c */
 283 bool user_select_files_from_tree(TREE_CTX *tree);
 284 int insert_tree_handler(void *ctx, int num_fields, char **row);
 285
 286 /* ua_prune.c */
 287 int prune_files(UAContext *ua, CLIENT *client, POOL *pool);
 288 int prune_jobs(UAContext *ua, CLIENT *client, POOL *pool, int JobType);
 289 int prune_stats(UAContext *ua, utime_t retention);
 290 bool prune_volume(UAContext *ua, MEDIA_DBR *mr);
 291 int job_delete_handler(void *ctx, int num_fields, char **row);
 292 int del_count_handler(void *ctx, int num_fields, char **row);
 293 int file_delete_handler(void *ctx, int num_fields, char **row);
 294 int get_prune_list_for_volume(UAContext *ua, MEDIA_DBR *mr, del_ctx *del);
 295 int exclude_running_jobs_from_list(del_ctx *prune_list);
 296
 297 /* ua_purge.c */
 298 bool is_volume_purged(UAContext *ua, MEDIA_DBR *mr, bool force=false);
 299 bool mark_media_purged(UAContext *ua, MEDIA_DBR *mr);
 300 void purge_files_from_volume(UAContext *ua, MEDIA_DBR *mr);
 301 bool purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr, bool force=false);
 302 void purge_files_from_jobs(UAContext *ua, char *jobs);
 303 void purge_jobs_from_catalog(UAContext *ua, char *jobs);
 304 void purge_job_list_from_catalog(UAContext *ua, del_ctx &del);
 305 void purge_files_from_job_list(UAContext *ua, del_ctx &del);
 306
 307
 308 /* ua_run.c */
 309 extern int run_cmd(UAContext *ua, const char *cmd);
 310
 311 /* verify.c */
 312 extern bool do_verify(JCR *jcr);
 313 extern bool do_verify_init(JCR *jcr);
 314 extern void verify_cleanup(JCR *jcr, int TermCode);