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-2004 Kern Sibbald and John Walker
   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 as
  11    published by the Free Software Foundation; either version 2 of
  12    the License, or (at your option) any later version.
  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 GNU
  17    General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public
  20    License along with this program; if not, write to the Free
  21    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  22    MA 02111-1307, USA.
  23
  24  */
  25
  26 /* authenticate.c */
  27 extern int authenticate_storage_daemon(JCR *jcr);
  28 extern int authenticate_file_daemon(JCR *jcr);
  29 extern int authenticate_user_agent(UAContext *ua);
  30
  31 /* autoprune.c */
  32 extern int do_autoprune(JCR *jcr);
  33 extern int prune_volumes(JCR *jcr);
  34
  35 /* autorecycle.c */
  36 extern int recycle_oldest_purged_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  37 extern int recycle_volume(JCR *jcr, MEDIA_DBR *mr);
  38 extern int find_recycled_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  39
  40 /* backup.c */
  41 extern int wait_for_job_termination(JCR *jcr);
  42
  43 /* bsr.c */
  44 RBSR *new_bsr();
  45 void free_bsr(RBSR *bsr);
  46 int complete_bsr(UAContext *ua, RBSR *bsr);
  47 int write_bsr_file(UAContext *ua, RBSR *bsr);
  48 void add_findex(RBSR *bsr, uint32_t JobId, int32_t findex);
  49 RBSR_FINDEX *new_findex();
  50
  51
  52 /* catreq.c */
  53 extern void catalog_request(JCR *jcr, BSOCK *bs, char *buf);
  54 extern void catalog_update(JCR *jcr, BSOCK *bs, char *buf);
  55
  56 /* dird_conf.c */
  57 extern const char *level_to_str(int level);
  58
  59 /* expand.c */
  60 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp);
  61
  62
  63 /* fd_cmds.c */
  64 extern int connect_to_file_daemon(JCR *jcr, int retry_interval,
  65                                   int max_retry_time, int verbose);
  66 extern int send_include_list(JCR *jcr);
  67 extern int send_exclude_list(JCR *jcr);
  68 extern int send_bootstrap_file(JCR *jcr);
  69 extern int send_level_command(JCR *jcr);
  70 extern int get_attributes_and_put_in_catalog(JCR *jcr);
  71 extern int get_attributes_and_compare_to_catalog(JCR *jcr, JobId_t JobId);
  72 extern int put_file_into_catalog(JCR *jcr, long file_index, char *fname,
  73                           char *link, char *attr, int stream);
  74 extern void get_level_since_time(JCR *jcr, char *since, int since_len);
  75 extern int send_run_before_and_after_commands(JCR *jcr);
  76
  77 /* getmsg.c */
  78 enum e_prtmsg {
  79    DISPLAY_ERROR,
  80    NO_DISPLAY
  81 };
  82 extern int response(JCR *jcr, BSOCK *fd, char *resp, const char *cmd, e_prtmsg prtmsg);
  83
  84 /* job.c */
  85 extern void set_jcr_defaults(JCR *jcr, JOB *job);
  86 extern void create_unique_job_name(JCR *jcr, const char *base_name);
  87 extern void update_job_end_record(JCR *jcr);
  88 extern bool get_or_create_client_record(JCR *jcr);
  89 extern bool get_or_create_fileset_record(JCR *jcr, FILESET_DBR *fsr);
  90 extern JobId_t run_job(JCR *jcr);
  91 extern int cancel_job(UAContext *ua, JCR *jcr);
  92 extern void init_jcr_job_record(JCR *jcr);
  93
  94 /* mountreq.c */
  95 extern void mount_request(JCR *jcr, BSOCK *bs, char *buf);
  96
  97 /* msgchan.c */
  98 extern int connect_to_storage_daemon(JCR *jcr, int retry_interval,
  99                               int max_retry_time, int verbose);
 100 extern int start_storage_daemon_job(JCR *jcr);
 101 extern int start_storage_daemon_message_thread(JCR *jcr);
 102 extern int bget_dirmsg(BSOCK *bs);
 103 extern void wait_for_storage_daemon_termination(JCR *jcr);
 104
 105 /* next_vol.c */
 106 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, bool create);
 107 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr);
 108 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason);
 109
 110 /* newvol.c */
 111 bool newVolume(JCR *jcr, MEDIA_DBR *mr);
 112
 113 /* ua_acl.c */
 114 bool acl_access_ok(UAContext *ua, int acl, char *item);
 115 bool acl_access_ok(UAContext *ua, int acl, char *item, int len);
 116
 117 /* ua_cmds.c */
 118 int do_a_command(UAContext *ua, const char *cmd);
 119 int do_a_dot_command(UAContext *ua, const char *cmd);
 120 int qmessagescmd(UAContext *ua, const char *cmd);
 121 int open_db(UAContext *ua);
 122 void close_db(UAContext *ua);
 123 enum e_pool_op {
 124    POOL_OP_UPDATE,
 125    POOL_OP_CREATE
 126 };
 127 int create_pool(JCR *jcr, B_DB *db, POOL *pool, e_pool_op op);
 128 void set_pool_dbr_defaults_in_media_dbr(MEDIA_DBR *mr, POOL_DBR *pr);
 129
 130 /* ua_input.c */
 131 int get_cmd(UAContext *ua, const char *prompt);
 132 int get_pint(UAContext *ua, const char *prompt);
 133 int get_yesno(UAContext *ua, const char *prompt);
 134 void parse_ua_args(UAContext *ua);
 135
 136 /* ua_label.c */
 137 bool is_volume_name_legal(UAContext *ua, const char *name);
 138
 139 /* ua_output.c */
 140 void prtit(void *ctx, const char *msg);
 141 int complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool);
 142 RUN *find_next_run(RUN *run, JOB *job, time_t &runtime);
 143
 144 /* ua_server.c */
 145 void bsendmsg(void *sock, const char *fmt, ...);
 146 UAContext *new_ua_context(JCR *jcr);
 147 JCR *new_control_jcr(const char *base_name, int job_type);
 148 void free_ua_context(UAContext *ua);
 149
 150 /* ua_select.c */
 151 STORE   *select_storage_resource(UAContext *ua);
 152 JOB     *select_job_resource(UAContext *ua);
 153 JOB     *select_restore_job_resource(UAContext *ua);
 154 CLIENT  *select_client_resource(UAContext *ua);
 155 FILESET *select_fileset_resource(UAContext *ua);
 156 int     select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr);
 157 int     select_media_dbr(UAContext *ua, MEDIA_DBR *mr);
 158 bool    select_pool_dbr(UAContext *ua, POOL_DBR *pr);
 159 int     select_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 160
 161 void    start_prompt(UAContext *ua, const char *msg);
 162 void    add_prompt(UAContext *ua, const char *prompt);
 163 int     do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt);
 164 CAT    *get_catalog_resource(UAContext *ua);
 165 STORE  *get_storage_resource(UAContext *ua, int use_default);
 166 int     get_media_type(UAContext *ua, char *MediaType, int max_media);
 167 bool    get_pool_dbr(UAContext *ua, POOL_DBR *pr);
 168 int     get_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 169 POOL   *get_pool_resource(UAContext *ua);
 170 POOL   *select_pool_resource(UAContext *ua);
 171 CLIENT *get_client_resource(UAContext *ua);
 172 int     get_job_dbr(UAContext *ua, JOB_DBR *jr);
 173
 174 int find_arg_keyword(UAContext *ua, const char **list);
 175 int find_arg(UAContext *ua, const char *keyword);
 176 int find_arg_with_value(UAContext *ua, const char *keyword);
 177 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list);
 178 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg);
 179 bool get_level_from_name(JCR *jcr, const char *level_name);
 180
 181 /* ua_tree.c */
 182 bool user_select_files_from_tree(TREE_CTX *tree);
 183 int insert_tree_handler(void *ctx, int num_fields, char **row);
 184
 185 /* ua_prune.c */
 186 int prune_files(UAContext *ua, CLIENT *client);
 187 int prune_jobs(UAContext *ua, CLIENT *client, int JobType);
 188 int prune_volume(UAContext *ua, MEDIA_DBR *mr);
 189
 190 /* ua_purge.c */
 191 int purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr);