/*
- * Prototypes for lib directory of Bacula
- *
- * Version $Id$
- */
-/*
- Copyright (C) 2000-2005 Kern Sibbald
+ Bacula® - The Network Backup Solution
- This program is free software; you can redistribute it and/or
- modify it under the terms of the GNU General Public License as
- published by the Free Software Foundation; either version 2 of
- the License, or (at your option) any later version.
+ Copyright (C) 2000-2012 Free Software Foundation Europe e.V.
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
+ The main author of Bacula is Kern Sibbald, with contributions from
+ many others, a complete list can be found in the file AUTHORS.
+ This program is Free Software; you can redistribute it and/or
+ modify it under the terms of version three of the GNU Affero General Public
+ License as published by the Free Software Foundation and included
+ in the file LICENSE.
+
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
- You should have received a copy of the GNU General Public
- License along with this program; if not, write to the Free
- Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
- MA 02111-1307, USA.
+ You should have received a copy of the GNU Affero General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ 02110-1301, USA.
+ Bacula® is a registered trademark of Kern Sibbald.
+ The licensor of Bacula is the Free Software Foundation Europe
+ (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
+ Switzerland, email:ftf@fsfeurope.org.
+*/
+/*
+ * Prototypes for lib directory of Bacula
+ *
*/
-struct JCR;
+#ifndef __LIBPROTOS_H
+#define __LIBPROTOS_H
+
+class JCR;
/* attr.c */
-ATTR *new_attr();
+ATTR *new_attr(JCR *jcr);
void free_attr(ATTR *attr);
-int unpack_attributes_record(JCR *jcr, int32_t stream, char *rec, ATTR *attr);
+int unpack_attributes_record(JCR *jcr, int32_t stream, char *rec, int32_t reclen, ATTR *attr);
void build_attr_output_fnames(JCR *jcr, ATTR *attr);
void print_ls_output(JCR *jcr, ATTR *attr);
/* base64.c */
void base64_init (void);
-int to_base64 (intmax_t value, char *where);
-int from_base64 (intmax_t *value, char *where);
-int bin_to_base64 (char *buf, char *bin, int len);
+int to_base64 (int64_t value, char *where);
+int from_base64 (int64_t *value, char *where);
+int bin_to_base64 (char *buf, int buflen, char *bin, int binlen,
+ int compatible);
+int base64_to_bin(char *dest, int destlen, char *src, int srclen);
/* bsys.c */
char *bstrncpy (char *dest, const char *src, int maxlen);
char *bstrncpy (char *dest, POOL_MEM &src, int maxlen);
char *bstrncat (char *dest, const char *src, int maxlen);
char *bstrncat (char *dest, POOL_MEM &src, int maxlen);
+bool bstrcmp (const char *s1, const char *s2);
+int cstrlen (const char *str);
void *b_malloc (const char *file, int line, size_t size);
-#ifndef DEBUG
+#ifndef bmalloc
void *bmalloc (size_t size);
#endif
+void bfree (void *buf);
void *brealloc (void *buf, size_t size);
void *bcalloc (size_t size1, size_t size2);
int bsnprintf (char *str, int32_t size, const char *format, ...);
int pool_sprintf (char *pool_buf, const char *fmt, ...);
void create_pid_file (char *dir, const char *progname, int port);
int delete_pid_file (char *dir, const char *progname, int port);
-void drop (char *uid, char *gid);
-int bmicrosleep (time_t sec, long usec);
+void drop (char *uid, char *gid, bool keep_readall_caps);
+int bmicrosleep (int32_t sec, int32_t usec);
char *bfgets (char *s, int size, FILE *fd);
+char *bfgets (POOLMEM *&s, FILE *fd);
void make_unique_filename (POOLMEM **name, int Id, char *what);
#ifndef HAVE_STRTOLL
long long int strtoll (const char *ptr, char **endptr, int base);
#endif
void read_state_file(char *dir, const char *progname, int port);
-int bstrerror(int errnum, char *buf, size_t bufsiz);
+int b_strerror(int errnum, char *buf, size_t bufsiz);
+char *escape_filename(const char *file_path);
+int Zdeflate(char *in, int in_len, char *out, int &out_len);
+int Zinflate(char *in, int in_len, char *out, int &out_len);
+void stack_trace();
+int safer_unlink(const char *pathname, const char *regex);
/* bnet.c */
int32_t bnet_recv (BSOCK *bsock);
bool bnet_fsend (BSOCK *bs, const char *fmt, ...);
bool bnet_set_buffer_size (BSOCK *bs, uint32_t size, int rw);
bool bnet_sig (BSOCK *bs, int sig);
-#ifdef HAVE_TLS
-int bnet_tls_server (TLS_CONTEXT *ctx, BSOCK *bsock,
- alist *verify_list);
-int bnet_tls_client (TLS_CONTEXT *ctx, BSOCK *bsock);
-#endif /* HAVE_TLS */
+bool bnet_tls_server (TLS_CONTEXT *ctx, BSOCK *bsock,
+ alist *verify_list);
+bool bnet_tls_client (TLS_CONTEXT *ctx, BSOCK *bsock,
+ alist *verify_list);
BSOCK * bnet_connect (JCR *jcr, int retry_interval,
- int max_retry_time, const char *name, char *host, char *service,
+ utime_t max_retry_time, utime_t heart_beat,
+ const char *name, char *host, char *service,
int port, int verbose);
void bnet_close (BSOCK *bsock);
BSOCK * init_bsock (JCR *jcr, int sockfd, const char *who, const char *ip,
int port, struct sockaddr *client_addr);
+#ifdef HAVE_WIN32
+#ifndef socklen_t
+#define socklen_t int
+#endif
+#endif
+int bnet_get_peer (BSOCK *bs, char *buf, socklen_t buflen);
BSOCK * dup_bsock (BSOCK *bsock);
void term_bsock (BSOCK *bsock);
const char *bnet_strerror (BSOCK *bsock);
const char *bnet_sig_to_ascii (BSOCK *bsock);
int bnet_wait_data (BSOCK *bsock, int sec);
int bnet_wait_data_intr (BSOCK *bsock, int sec);
-int bnet_despool_to_bsock (BSOCK *bsock, void update(ssize_t size), ssize_t size);
bool is_bnet_stop (BSOCK *bsock);
int is_bnet_error (BSOCK *bsock);
void bnet_suppress_error_messages(BSOCK *bsock, bool flag);
int close_bpipe(BPIPE *bpipe);
/* cram-md5.c */
-int cram_md5_get_auth(BSOCK *bs, char *password, int *tls_remote_need);
-int cram_md5_auth(BSOCK *bs, char *password, int tls_local_need);
-void hmac_md5(uint8_t* text, int text_len, uint8_t* key,
- int key_len, uint8_t *hmac);
+bool cram_md5_respond(BSOCK *bs, const char *password, int *tls_remote_need, int *compatible);
+bool cram_md5_challenge(BSOCK *bs, const char *password, int tls_local_need, int compatible);
+void hmac_md5(uint8_t* text, int text_len, uint8_t* key, int key_len, uint8_t *hmac);
/* crc32.c */
uint32_t bcrc32(uint8_t *buf, int len);
+/* crypto.c */
+int init_crypto (void);
+int cleanup_crypto (void);
+DIGEST * crypto_digest_new (JCR *jcr, crypto_digest_t type);
+bool crypto_digest_update (DIGEST *digest, const uint8_t *data, uint32_t length);
+bool crypto_digest_finalize (DIGEST *digest, uint8_t *dest, uint32_t *length);
+void crypto_digest_free (DIGEST *digest);
+SIGNATURE * crypto_sign_new (JCR *jcr);
+crypto_error_t crypto_sign_get_digest (SIGNATURE *sig, X509_KEYPAIR *keypair,
+ crypto_digest_t &algorithm, DIGEST **digest);
+crypto_error_t crypto_sign_verify (SIGNATURE *sig, X509_KEYPAIR *keypair, DIGEST *digest);
+int crypto_sign_add_signer (SIGNATURE *sig, DIGEST *digest, X509_KEYPAIR *keypair);
+int crypto_sign_encode (SIGNATURE *sig, uint8_t *dest, uint32_t *length);
+SIGNATURE * crypto_sign_decode (JCR *jcr, const uint8_t *sigData, uint32_t length);
+void crypto_sign_free (SIGNATURE *sig);
+CRYPTO_SESSION * crypto_session_new (crypto_cipher_t cipher, alist *pubkeys);
+void crypto_session_free (CRYPTO_SESSION *cs);
+bool crypto_session_encode (CRYPTO_SESSION *cs, uint8_t *dest, uint32_t *length);
+crypto_error_t crypto_session_decode (const uint8_t *data, uint32_t length, alist *keypairs, CRYPTO_SESSION **session);
+CRYPTO_SESSION * crypto_session_decode (const uint8_t *data, uint32_t length);
+CIPHER_CONTEXT * crypto_cipher_new (CRYPTO_SESSION *cs, bool encrypt, uint32_t *blocksize);
+bool crypto_cipher_update (CIPHER_CONTEXT *cipher_ctx, const uint8_t *data, uint32_t length, const uint8_t *dest, uint32_t *written);
+bool crypto_cipher_finalize (CIPHER_CONTEXT *cipher_ctx, uint8_t *dest, uint32_t *written);
+void crypto_cipher_free (CIPHER_CONTEXT *cipher_ctx);
+X509_KEYPAIR * crypto_keypair_new (void);
+X509_KEYPAIR * crypto_keypair_dup (X509_KEYPAIR *keypair);
+int crypto_keypair_load_cert (X509_KEYPAIR *keypair, const char *file);
+bool crypto_keypair_has_key (const char *file);
+int crypto_keypair_load_key (X509_KEYPAIR *keypair, const char *file, CRYPTO_PEM_PASSWD_CB *pem_callback, const void *pem_userdata);
+void crypto_keypair_free (X509_KEYPAIR *keypair);
+int crypto_default_pem_callback (char *buf, int size, const void *userdata);
+const char * crypto_digest_name (DIGEST *digest);
+crypto_digest_t crypto_digest_stream_type (int stream);
+const char * crypto_strerror (crypto_error_t error);
+
/* daemon.c */
void daemon_start ();
/* edit.c */
uint64_t str_to_uint64(char *str);
int64_t str_to_int64(char *str);
+#define str_to_int32(str) ((int32_t)str_to_int64(str))
char * edit_uint64_with_commas (uint64_t val, char *buf);
+char * edit_uint64_with_suffix (uint64_t val, char *buf);
char * add_commas (char *val, char *buf);
char * edit_uint64 (uint64_t val, char *buf);
char * edit_int64 (int64_t val, char *buf);
-int duration_to_utime (char *str, utime_t *value);
-int size_to_uint64(char *str, int str_len, uint64_t *rtn_value);
+char * edit_int64_with_commas (int64_t val, char *buf);
+bool duration_to_utime (char *str, utime_t *value);
+bool size_to_uint64(char *str, int str_len, uint64_t *rtn_value);
+bool speed_to_uint64(char *str, int str_len, uint64_t *rtn_value);
char *edit_utime (utime_t val, char *buf, int buf_len);
bool is_a_number (const char *num);
+bool is_a_number_list (const char *n);
bool is_an_integer (const char *n);
-bool is_name_valid (char *name, POOLMEM **msg);
+bool is_name_valid (const char *name, POOLMEM **msg);
/* jcr.c (most definitions are in src/jcr.h) */
-void init_last_jobs_list();
-void term_last_jobs_list();
-void lock_last_jobs_list();
-void unlock_last_jobs_list();
-void read_last_jobs_list(int fd, uint64_t addr);
+void init_last_jobs_list();
+void term_last_jobs_list();
+void lock_last_jobs_list();
+void unlock_last_jobs_list();
+bool read_last_jobs_list(int fd, uint64_t addr);
uint64_t write_last_jobs_list(int fd, uint64_t addr);
-void write_state_file(char *dir, const char *progname, int port);
-void job_end_push(JCR *jcr, void job_end_cb(JCR *jcr,void *), void *ctx);
+void write_state_file(char *dir, const char *progname, int port);
+void job_end_push(JCR *jcr, void job_end_cb(JCR *jcr,void *), void *ctx);
+void lock_jobs();
+void unlock_jobs();
+JCR *jcr_walk_start();
+JCR *jcr_walk_next(JCR *prev_jcr);
+void jcr_walk_end(JCR *jcr);
+int job_count();
+JCR *get_jcr_from_tsd();
+void set_jcr_in_tsd(JCR *jcr);
+void remove_jcr_from_tsd(JCR *jcr);
+uint32_t get_jobid_from_tsd();
+uint32_t get_jobid_from_tid(pthread_t tid);
/* lex.c */
void lex_unget_char (LEX *lf);
const char * lex_tok_to_str (int token);
int lex_get_token (LEX *lf, int expect);
+void lex_set_default_error_handler (LEX *lf);
+int lex_set_error_handler_error_type (LEX *lf, int err_type);
/* message.c */
void my_name_is (int argc, char *argv[], const char *name);
void close_msg (JCR *jcr);
void add_msg_dest (MSGS *msg, int dest, int type, char *where, char *dest_code);
void rem_msg_dest (MSGS *msg, int dest, int type, char *where);
-void Jmsg (JCR *jcr, int type, time_t mtime, const char *fmt, ...);
-void dispatch_message (JCR *jcr, int type, time_t mtime, char *buf);
+void Jmsg (JCR *jcr, int type, utime_t mtime, const char *fmt, ...);
+void dispatch_message (JCR *jcr, int type, utime_t mtime, char *buf);
void init_console_msg (const char *wd);
void free_msgs_res (MSGS *msgs);
void dequeue_messages (JCR *jcr);
void set_trace (int trace_flag);
-void set_exit_on_error (int value);
+bool get_trace (void);
+void set_hangup (int hangup_value);
+int get_hangup (void);
+void set_db_type (const char *name);
+void register_message_callback(void msg_callback(int type, char *msg));
/* bnet_server.c */
-void bnet_thread_server(dlist *addr, int max_clients, workq_t *client_wq,
+void bnet_thread_server(dlist *addr_list, int max_clients, workq_t *client_wq,
void *handle_client_request(void *bsock));
void bnet_stop_thread_server(pthread_t tid);
void bnet_server (int port, void handle_client_request(BSOCK *bsock));
BSOCK * bnet_bind (int port);
BSOCK * bnet_accept (BSOCK *bsock, char *who);
-/* idcache.c */
-char *getuser(uid_t uid);
-void free_getuser_cache();
-char *getgroup (gid_t gid);
-void free_getgroup_cache();
-
-/* python.c */
+/* pythonlib.c */
typedef int (EVENT_HANDLER)(JCR *jcr, const char *event);
-void init_python_interpreter(const char *progname, const char *scripts,
- const char *module);
-void term_python_interpreter();
-//extern EVENT_HANDLER *generate_daemon_event;
+//EVENT_HANDLER *generate_daemon_event;
int generate_daemon_event(JCR *jcr, const char *event);
/* signal.c */
void init_stack_dump (void);
/* scan.c */
+void strip_leading_space (char *str);
void strip_trailing_junk (char *str);
+void strip_trailing_newline (char *str);
+
void strip_trailing_slashes (char *dir);
bool skip_spaces (char **msg);
bool skip_nonspaces (char **msg);
char *next_arg(char **s);
int parse_args(POOLMEM *cmd, POOLMEM **args, int *argc,
char **argk, char **argv, int max_args);
+int parse_args_only(POOLMEM *cmd, POOLMEM **args, int *argc,
+ char **argk, char **argv, int max_args);
void split_path_and_filename(const char *fname, POOLMEM **path,
int *pnl, POOLMEM **file, int *fnl);
int bsscanf(const char *buf, const char *fmt, ...);
/* tls.c */
-#ifdef HAVE_TLS
-int init_tls (void);
-int cleanup_tls (void);
TLS_CONTEXT *new_tls_context (const char *ca_certfile,
const char *ca_certdir,
- const char *certfile,
- const char *keyfile,
- TLS_PEM_PASSWD_CB *pem_callback,
- const void *pem_userdata,
- const char *dhfile,
- bool verify_peer);
+ const char *certfile,
+ const char *keyfile,
+ CRYPTO_PEM_PASSWD_CB *pem_callback,
+ const void *pem_userdata,
+ const char *dhfile,
+ bool verify_peer);
void free_tls_context (TLS_CONTEXT *ctx);
-bool tls_postconnect_verify_host (TLS_CONNECTION *tls,
- const char *host);
-bool tls_postconnect_verify_cn (TLS_CONNECTION *tls,
- alist *verify_list);
+#ifdef HAVE_TLS
+bool tls_postconnect_verify_host(JCR *jcr, TLS_CONNECTION *tls,
+ const char *host);
+bool tls_postconnect_verify_cn(JCR *jcr, TLS_CONNECTION *tls,
+ alist *verify_list);
TLS_CONNECTION *new_tls_connection (TLS_CONTEXT *ctx, int fd);
-void free_tls_connection (TLS_CONNECTION *tls);
-bool tls_bsock_connect (BSOCK *bsock);
bool tls_bsock_accept (BSOCK *bsock);
-void tls_bsock_shutdown (BSOCK *bsock);
-int tls_bsock_writen (BSOCK *bsock, char *ptr, int32_t nbytes);
-int tls_bsock_readn (BSOCK *bsock, char *ptr, int32_t nbytes);
+int tls_bsock_writen (BSOCK *bsock, char *ptr, int32_t nbytes);
+int tls_bsock_readn (BSOCK *bsock, char *ptr, int32_t nbytes);
#endif /* HAVE_TLS */
+bool tls_bsock_connect (BSOCK *bsock);
+void tls_bsock_shutdown (BSOCK *bsock);
+void free_tls_connection (TLS_CONNECTION *tls);
+bool get_tls_require (TLS_CONTEXT *ctx);
+bool get_tls_enable (TLS_CONTEXT *ctx);
/* util.c */
-int is_buf_zero (char *buf, int len);
+
+extern "C" {
+typedef char *(*job_code_callback_t)(JCR *, const char *);
+}
+
+bool is_buf_zero (char *buf, int len);
void lcase (char *str);
void bash_spaces (char *str);
void bash_spaces (POOL_MEM &pm);
void unbash_spaces (char *str);
void unbash_spaces (POOL_MEM &pm);
-char * encode_time (time_t time, char *buf);
+char * encode_time (utime_t time, char *buf);
char * encode_mode (mode_t mode, char *buf);
int do_shell_expansion (char *name, int name_len);
void jobstatus_to_ascii (int JobStatus, char *msg, int maxlen);
-int run_program (char *prog, int wait, POOLMEM *results);
-int run_program_full_output (char *prog, int wait, POOLMEM *results);
+void jobstatus_to_ascii_gui (int JobStatus, char *msg, int maxlen);
+int run_program (char *prog, int wait, POOLMEM *&results);
+int run_program_full_output (char *prog, int wait, POOLMEM *&results);
+char * action_on_purge_to_string(int aop, POOL_MEM &ret);
const char * job_type_to_str (int type);
const char * job_status_to_str (int stat);
const char * job_level_to_str (int level);
+const char * volume_status_to_str (const char *status);
void make_session_key (char *key, char *seed, int mode);
-POOLMEM *edit_job_codes(JCR *jcr, char *omsg, char *imsg, const char *to);
-void set_working_directory(char *wd);
+void encode_session_key (char *encode, char *session, char *key, int maxlen);
+void decode_session_key (char *decode, char *session, char *key, int maxlen);
+POOLMEM * edit_job_codes (JCR *jcr, char *omsg, char *imsg, const char *to, job_code_callback_t job_code_callback = NULL);
+void set_working_directory (char *wd);
+const char * last_path_separator (const char *str);
/* watchdog.c */
watchdog_t *new_watchdog(void);
bool register_watchdog(watchdog_t *wd);
bool unregister_watchdog(watchdog_t *wd);
+bool is_watchdog();
/* timers.c */
-btimer_t *start_child_timer(pid_t pid, uint32_t wait);
+btimer_t *start_child_timer(JCR *jcr, pid_t pid, uint32_t wait);
void stop_child_timer(btimer_t *wid);
-btimer_t *start_thread_timer(pthread_t tid, uint32_t wait);
+btimer_t *start_thread_timer(JCR *jcr, pthread_t tid, uint32_t wait);
void stop_thread_timer(btimer_t *wid);
btimer_t *start_bsock_timer(BSOCK *bs, uint32_t wait);
void stop_bsock_timer(btimer_t *wid);
+
+#endif /* __LIBPROTOS_H */
projects / bacula / bacula / blobdiff