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 plus additions
  11    that are listed 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 John Walker.
  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 int prune_volumes(JCR *jcr);
  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);
  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
  61 /* bsr.c */
  62 RBSR *new_bsr();
  63 void free_bsr(RBSR *bsr);
  64 bool complete_bsr(UAContext *ua, RBSR *bsr);
  65 uint32_t write_bsr_file(UAContext *ua, RESTORE_CTX &rx);
  66 void add_findex(RBSR *bsr, uint32_t JobId, int32_t findex);
  67 void add_findex_all(RBSR *bsr, uint32_t JobId);
  68 RBSR_FINDEX *new_findex();
  69 void make_unique_restore_filename(UAContext *ua, POOLMEM **fname);
  70
  71
  72 /* catreq.c */
  73 extern void catalog_request(JCR *jcr, BSOCK *bs);
  74 extern void catalog_update(JCR *jcr, BSOCK *bs);
  75
  76 /* dird_conf.c */
  77 extern const char *level_to_str(int level);
  78
  79 /* expand.c */
  80 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp);
  81
  82
  83 /* fd_cmds.c */
  84 extern int connect_to_file_daemon(JCR *jcr, int retry_interval,
  85                                   int max_retry_time, int verbose);
  86 extern bool send_include_list(JCR *jcr);
  87 extern bool send_exclude_list(JCR *jcr);
  88 extern bool send_bootstrap_file(JCR *jcr, BSOCK *sock);
  89 extern bool send_level_command(JCR *jcr);
  90 extern int get_attributes_and_put_in_catalog(JCR *jcr);
  91 extern int get_attributes_and_compare_to_catalog(JCR *jcr, JobId_t JobId);
  92 extern int put_file_into_catalog(JCR *jcr, long file_index, char *fname,
  93                           char *link, char *attr, int stream);
  94 extern void get_level_since_time(JCR *jcr, char *since, int since_len);
  95 extern int send_runscripts_commands(JCR *jcr);
  96
  97 /* getmsg.c */
  98 enum e_prtmsg {
  99    DISPLAY_ERROR,
 100    NO_DISPLAY
 101 };
 102 extern bool response(JCR *jcr, BSOCK *fd, char *resp, const char *cmd, e_prtmsg prtmsg);
 103
 104 /* job.c */
 105 extern void set_jcr_defaults(JCR *jcr, JOB *job);
 106 extern void create_unique_job_name(JCR *jcr, const char *base_name);
 107 extern void update_job_end_record(JCR *jcr);
 108 extern bool get_or_create_client_record(JCR *jcr);
 109 extern bool get_or_create_fileset_record(JCR *jcr);
 110 extern DBId_t get_or_create_pool_record(JCR *jcr, char *pool_name);
 111 extern void apply_pool_overrides(JCR *jcr);
 112 extern JobId_t run_job(JCR *jcr);
 113 extern bool cancel_job(UAContext *ua, JCR *jcr);
 114 extern void get_job_storage(USTORE *store, JOB *job, RUN *run);
 115 extern void init_jcr_job_record(JCR *jcr);
 116 extern void update_job_end(JCR *jcr, int TermCode);
 117 extern void copy_rwstorage(JCR *jcr, alist *storage, const char *where);
 118 extern void set_rwstorage(JCR *jcr, USTORE *store);
 119 extern void free_rwstorage(JCR *jcr);
 120 extern void copy_wstorage(JCR *jcr, alist *storage, const char *where);
 121 extern void set_wstorage(JCR *jcr, USTORE *store);
 122 extern void free_wstorage(JCR *jcr);
 123 extern void copy_rstorage(JCR *jcr, alist *storage, const char *where);
 124 extern void set_rstorage(JCR *jcr, USTORE *store);
 125 extern void free_rstorage(JCR *jcr);
 126 extern bool setup_job(JCR *jcr);
 127 extern void create_clones(JCR *jcr);
 128 extern bool create_restore_bootstrap_file(JCR *jcr);
 129
 130 /* migration.c */
 131 extern bool do_migration(JCR *jcr);
 132 extern bool do_migration_init(JCR *jcr);
 133 extern void migration_cleanup(JCR *jcr, int TermCode);
 134 extern bool set_migration_wstorage(JCR *jcr, POOL *pool);
 135
 136
 137 /* mountreq.c */
 138 extern void mount_request(JCR *jcr, BSOCK *bs, char *buf);
 139
 140 /* msgchan.c */
 141 extern bool connect_to_storage_daemon(JCR *jcr, int retry_interval,
 142                               int max_retry_time, int verbose);
 143 extern bool start_storage_daemon_job(JCR *jcr, alist *rstore, alist *wstore);
 144 extern bool start_storage_daemon_message_thread(JCR *jcr);
 145 extern int bget_dirmsg(BSOCK *bs);
 146 extern void wait_for_storage_daemon_termination(JCR *jcr);
 147
 148 /* next_vol.c */
 149 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, int index, bool create);
 150 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr);
 151 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason);
 152
 153 /* newvol.c */
 154 bool newVolume(JCR *jcr, MEDIA_DBR *mr);
 155
 156 /* python.c */
 157 int generate_job_event(JCR *jcr, const char *event);
 158
 159
 160 /* restore.c */
 161 extern bool do_restore(JCR *jcr);
 162 extern bool do_restore_init(JCR *jcr);
 163 extern void restore_cleanup(JCR *jcr, int TermCode);
 164
 165
 166 /* ua_acl.c */
 167 bool acl_access_ok(UAContext *ua, int acl, char *item);
 168 bool acl_access_ok(UAContext *ua, int acl, char *item, int len);
 169
 170 /* ua_cmds.c */
 171 int do_a_command(UAContext *ua, const char *cmd);
 172 int do_a_dot_command(UAContext *ua, const char *cmd);
 173 int qmessagescmd(UAContext *ua, const char *cmd);
 174 bool open_client_db(UAContext *ua);
 175 bool open_db(UAContext *ua);
 176 void close_db(UAContext *ua);
 177 enum e_pool_op {
 178    POOL_OP_UPDATE,
 179    POOL_OP_CREATE
 180 };
 181 int create_pool(JCR *jcr, B_DB *db, POOL *pool, e_pool_op op);
 182 void set_pool_dbr_defaults_in_media_dbr(MEDIA_DBR *mr, POOL_DBR *pr);
 183 bool set_pooldbr_recyclepoolid(JCR *jcr, B_DB *db, POOL_DBR *pr, POOL *pool);
 184 void set_pooldbr_from_poolres(POOL_DBR *pr, POOL *pool, e_pool_op op);
 185
 186 /* ua_input.c */
 187 int get_cmd(UAContext *ua, const char *prompt);
 188 bool get_pint(UAContext *ua, const char *prompt);
 189 bool get_yesno(UAContext *ua, const char *prompt);
 190 bool is_yesno(char *val, int *ret);
 191 int get_enabled(UAContext *ua, const char *val);
 192 void parse_ua_args(UAContext *ua);
 193
 194 /* ua_label.c */
 195 bool is_volume_name_legal(UAContext *ua, const char *name);
 196 int get_num_drives_from_SD(UAContext *ua);
 197 void update_slots(UAContext *ua);
 198
 199 /* ua_update.c */
 200 void update_vol_pool(UAContext *ua, char *val, MEDIA_DBR *mr, POOL_DBR *opr);
 201
 202 /* ua_output.c */
 203 void prtit(void *ctx, const char *msg);
 204 bool complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool);
 205 RUN *find_next_run(RUN *run, JOB *job, time_t &runtime, int ndays);
 206
 207 /* ua_restore.c */
 208 int get_next_jobid_from_list(char **p, JobId_t *JobId);
 209 void find_storage_resource(UAContext *ua, RESTORE_CTX &rx, char *Storage, char *MediaType);
 210
 211 /* ua_server.c */
 212 void bsendmsg(void *sock, const char *fmt, ...);
 213 UAContext *new_ua_context(JCR *jcr);
 214 JCR *new_control_jcr(const char *base_name, int job_type);
 215 void free_ua_context(UAContext *ua);
 216
 217 /* ua_select.c */
 218 STORE   *select_storage_resource(UAContext *ua);
 219 JOB     *select_job_resource(UAContext *ua);
 220 JOB     *select_restore_job_resource(UAContext *ua);
 221 CLIENT  *select_client_resource(UAContext *ua);
 222 FILESET *select_fileset_resource(UAContext *ua);
 223 int     select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr);
 224 int     select_media_dbr(UAContext *ua, MEDIA_DBR *mr);
 225 bool    select_pool_dbr(UAContext *ua, POOL_DBR *pr, char *argk="pool");
 226 int     select_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 227
 228 void    start_prompt(UAContext *ua, const char *msg);
 229 void    add_prompt(UAContext *ua, const char *prompt);
 230 int     do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt);
 231 CAT    *get_catalog_resource(UAContext *ua);
 232 STORE  *get_storage_resource(UAContext *ua, bool use_default);
 233 int     get_storage_drive(UAContext *ua, STORE *store);
 234 int     get_storage_slot(UAContext *ua, STORE *store);
 235 int     get_media_type(UAContext *ua, char *MediaType, int max_media);
 236 bool    get_pool_dbr(UAContext *ua, POOL_DBR *pr, char *argk="pool");
 237 int     get_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 238 POOL   *get_pool_resource(UAContext *ua);
 239 POOL   *select_pool_resource(UAContext *ua);
 240 CLIENT *get_client_resource(UAContext *ua);
 241 int     get_job_dbr(UAContext *ua, JOB_DBR *jr);
 242
 243 int find_arg_keyword(UAContext *ua, const char **list);
 244 int find_arg(UAContext *ua, const char *keyword);
 245 int find_arg_with_value(UAContext *ua, const char *keyword);
 246 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list);
 247 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg);
 248 bool get_level_from_name(JCR *jcr, const char *level_name);
 249
 250 /* ua_tree.c */
 251 bool user_select_files_from_tree(TREE_CTX *tree);
 252 int insert_tree_handler(void *ctx, int num_fields, char **row);
 253
 254 /* ua_prune.c */
 255 int prune_files(UAContext *ua, CLIENT *client);
 256 int prune_jobs(UAContext *ua, CLIENT *client, int JobType);
 257 bool prune_volume(UAContext *ua, MEDIA_DBR *mr);
 258
 259 /* ua_purge.c */
 260 bool mark_media_purged(UAContext *ua, MEDIA_DBR *mr);
 261 void purge_files_from_volume(UAContext *ua, MEDIA_DBR *mr );
 262 int purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr);
 263 void purge_files_from_job(UAContext *ua, JobId_t JobId);
 264 void purge_job_from_catalog(UAContext *ua, JobId_t JobId);
 265 void purge_job_records_from_catalog(UAContext *ua, JobId_t JobId);
 266
 267
 268 /* ua_run.c */
 269 extern int run_cmd(UAContext *ua, const char *cmd);
 270
 271 /* verify.c */
 272 extern bool do_verify(JCR *jcr);
 273 extern bool do_verify_init(JCR *jcr);
 274 extern void verify_cleanup(JCR *jcr, int TermCode);