Skip to content

Commit

Permalink
callerid: Allow specifying timezone for date/time.
Browse files Browse the repository at this point in the history 
The Caller ID generation routine currently is hardcoded
to always use the system time zone. This makes it possible
to optionally specify any TZ-format time zone.

Resolves: #98
ASTERISK-30330

(cherry picked from commit 8a03ed6)
  • Loading branch information
@InterLinked1 @asteriskteam
InterLinked1 authored and asteriskteam committed Jul 10, 2023
1 parent 8b81c5a commit c3b04a3
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 13 deletions.
45 changes: 45 additions & 0 deletions include/asterisk/callerid.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,26 @@ int callerid_generate(unsigned char *buf, const char *number, const char *name,
int callerid_full_generate(unsigned char *buf, const char *number, const char *name, const char *ddn, int redirecting,
int flags, int format, int callwaiting, struct ast_format *codec);

/*! \brief Generates a CallerID FSK stream in ulaw format suitable for transmission.
* \param buf Buffer to use. If "buf" is supplied, it will use that buffer instead of allocating its own.
* "buf" must be at least 32000 bytes in size of you want to be sure you don't have an overrun.
* \param number Use NULL for no number or "P" for "private"
* \param name name to be used
* \param ddn Dialable Directory Number (or NULL)
* \param redirecting Redirecting reason
* \param flags passed flags
* \param format Message format
* \param callwaiting callwaiting flag
* \param codec -- either AST_FORMAT_ULAW or AST_FORMAT_ALAW
* \param tz TZ-format time zone to use for date/time (NULL for system default)
* \details
* This function creates a stream of callerid (a callerid spill) data in ulaw format.
* \return It returns the size
* (in bytes) of the data (if it returns a size of 0, there is probably an error)
*/
int callerid_full_tz_generate(unsigned char *buf, const char *number, const char *name, const char *ddn, int redirecting,
int flags, int format, int callwaiting, struct ast_format *codec, const char *tz);

/*! \brief Create a callerID state machine
* \param cid_signalling Type of signalling in use
*
Expand Down Expand Up @@ -220,6 +240,24 @@ int ast_callerid_generate(unsigned char *buf, const char *name, const char *numb
int ast_callerid_full_generate(unsigned char *buf, const char *name, const char *number,
const char *ddn, int redirecting, int pres, int qualifier, int format, struct ast_format *codec);

/*! \brief Generate Caller-ID spill from the "callerid" field of asterisk (in e-mail address like format)
* \param buf buffer for output samples. See callerid_generate() for details regarding buffer.
* \param name Caller-ID Name
* \param number Caller-ID Number
* \param ddn Dialable Directory Number (or NULL)
* \param redirecting Redirecting Reason (-1 if N/A)
* \param pres Presentation (0 for default)
* \param qualifier Call Qualifier (0 for no, 1 for yes)
* \param format Message Format
* \param codec Asterisk codec (either AST_FORMAT_ALAW or AST_FORMAT_ULAW)
* \param tz TZ-format time zone name to use for date/time (NULL for system default)
*
* \details
* Like ast_callerid_generate but with additional parameters.
*/
int ast_callerid_full_tz_generate(unsigned char *buf, const char *name, const char *number,
const char *ddn, int redirecting, int pres, int qualifier, int format, struct ast_format *codec, const char *tz);

/*!
* \brief Generate message waiting indicator
* \param buf
Expand Down Expand Up @@ -247,6 +285,13 @@ int ast_callerid_callwaiting_generate(unsigned char *buf, const char *name, cons
int ast_callerid_callwaiting_full_generate(unsigned char *buf, const char *name, const char *number,
const char *ddn, int redirecting, int pres, int qualifier, struct ast_format *codec);

/*! \brief Generate Caller-ID spill but in a format suitable for Call Waiting(tm)'s Caller*ID(tm)
* \param tz TZ-format time zone for date/time (NULL for system default)
* \see ast_callerid_generate() for other details
*/
int ast_callerid_callwaiting_full_tz_generate(unsigned char *buf, const char *name, const char *number,
const char *ddn, int redirecting, int pres, int qualifier, struct ast_format *codec, const char *tz);

/*! \brief Destructively parse inbuf into name and location (or number)
* \details
* Parses callerid stream from inbuf and changes into useable form, outputted in name and location.
Expand Down
45 changes: 32 additions & 13 deletions main/callerid.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -737,7 +737,7 @@ void callerid_free(struct callerid_state *cid)
}

static int callerid_genmsg(char *msg, int size, const char *number, const char *name, int flags, int format,
const char *ddn, int redirecting)
const char *ddn, int redirecting, const char *tz)
{
struct timeval now = ast_tvnow();
struct ast_tm tm;
Expand All @@ -746,7 +746,7 @@ static int callerid_genmsg(char *msg, int size, const char *number, const char *
int i, x;

/* Get the time */
ast_localtime(&now, &tm, NULL);
ast_localtime(&now, &tm, tz);

ptr = msg;

Expand Down Expand Up @@ -850,8 +850,7 @@ static int callerid_genmsg(char *msg, int size, const char *number, const char *
return (ptr - msg);
}

int ast_callerid_vmwi_generate(unsigned char *buf, int active, int type, struct ast_format *codec,
const char* name, const char* number, int flags)
int ast_callerid_vmwi_generate(unsigned char *buf, int active, int type, struct ast_format *codec, const char* name, const char* number, int flags)
{
char msg[256];
int len = 0;
Expand All @@ -867,7 +866,7 @@ int ast_callerid_vmwi_generate(unsigned char *buf, int active, int type, struct
msg[0] = 0x82;

/* put date, number info at the right place */
len = callerid_genmsg(msg+2, sizeof(msg)-2, number, name, flags, CID_TYPE_MDMF, "", -1);
len = callerid_genmsg(msg+2, sizeof(msg)-2, number, name, flags, CID_TYPE_MDMF, "", -1, NULL);

/* length of MDMF CLI plus Message Waiting Structure */
msg[1] = len+3;
Expand Down Expand Up @@ -945,6 +944,13 @@ int callerid_generate(unsigned char *buf, const char *number, const char *name,

int callerid_full_generate(unsigned char *buf, const char *number, const char *name, const char *ddn, int redirecting,
int flags, int format, int callwaiting, struct ast_format *codec)
{
/* Default time zone is NULL (system time zone) */
return callerid_full_tz_generate(buf, number, name, ddn, redirecting, flags, format, callwaiting, codec, NULL);
}

int callerid_full_tz_generate(unsigned char *buf, const char *number, const char *name, const char *ddn, int redirecting,
int flags, int format, int callwaiting, struct ast_format *codec, const char *tz)
{
int bytes = 0;
int x, sum;
Expand All @@ -955,7 +961,7 @@ int callerid_full_generate(unsigned char *buf, const char *number, const char *n
float ci = 0.0;
float scont = 0.0;
char msg[256];
len = callerid_genmsg(msg, sizeof(msg), number, name, flags, format, ddn, redirecting);
len = callerid_genmsg(msg, sizeof(msg), number, name, flags, format, ddn, redirecting, tz);
if (!callwaiting) {
/* Wait a half a second */
for (x = 0; x < 4000; x++)
Expand Down Expand Up @@ -1101,11 +1107,11 @@ int ast_callerid_parse(char *input_str, char **name, char **location)
}

static int __ast_callerid_generate(unsigned char *buf, const char *name, const char *number,
const char *ddn, int redirecting, int pres, int qualifier, int format, int callwaiting, struct ast_format *codec)
const char *ddn, int redirecting, int pres, int qualifier, int format, int callwaiting, struct ast_format *codec, const char *tz)
{
int flags = 0;

ast_debug(1, "Caller ID Type %s: Number: %s, Name: %s, Redirecting No: %s, Redirecting Reason: %s, Pres: %s, Qualifier: %s, Format: %s\n",
ast_debug(1, "Caller ID Type %s: Number: %s, Name: %s, DDN: %s, Redirecting Reason: %s, Pres: %s, Qualifier: %s, Format: %s\n",
callwaiting ? "II" : "I", number, name, ddn, ast_redirecting_reason_describe(redirecting),
ast_named_caller_presentation(pres), qualifier ? "LDC" : "None", format == CID_TYPE_MDMF ? "MDMF" : "SDMF");

Expand All @@ -1126,30 +1132,43 @@ static int __ast_callerid_generate(unsigned char *buf, const char *name, const c
flags |= CID_QUALIFIER;
}

return callerid_full_generate(buf, number, name, ddn, redirecting, flags, format, callwaiting, codec);
return callerid_full_tz_generate(buf, number, name, ddn, redirecting, flags, format, callwaiting, codec, tz);
}

int ast_callerid_generate(unsigned char *buf, const char *name, const char *number, struct ast_format *codec)
{
return __ast_callerid_generate(buf, name, number, "", -1, 0, 0, CID_TYPE_MDMF, 0, codec);
return __ast_callerid_generate(buf, name, number, "", -1, 0, 0, CID_TYPE_MDMF, 0, codec, NULL);
}

int ast_callerid_callwaiting_generate(unsigned char *buf, const char *name, const char *number, struct ast_format *codec)
{
return __ast_callerid_generate(buf, name, number, "", -1, 0, 0, CID_TYPE_MDMF, 1, codec);
return __ast_callerid_generate(buf, name, number, "", -1, 0, 0, CID_TYPE_MDMF, 1, codec, NULL);
}

int ast_callerid_full_generate(unsigned char *buf, const char *name, const char *number,
const char *ddn, int redirecting, int pres, int qualifier, int format, struct ast_format *codec)
{
return __ast_callerid_generate(buf, name, number, ddn, redirecting, pres, qualifier, format, 0, codec);
return __ast_callerid_generate(buf, name, number, ddn, redirecting, pres, qualifier, format, 0, codec, NULL);
}

int ast_callerid_callwaiting_full_generate(unsigned char *buf, const char *name, const char *number,
const char *ddn, int redirecting, int pres, int qualifier, struct ast_format *codec)
{
/* Type II Caller ID (CWCID) only uses MDMF, so format isn't an argument */
return __ast_callerid_generate(buf, name, number, ddn, redirecting, pres, qualifier, CID_TYPE_MDMF, 1, codec);
return __ast_callerid_generate(buf, name, number, ddn, redirecting, pres, qualifier, CID_TYPE_MDMF, 1, codec, NULL);
}

int ast_callerid_full_tz_generate(unsigned char *buf, const char *name, const char *number,
const char *ddn, int redirecting, int pres, int qualifier, int format, struct ast_format *codec, const char *tz)
{
return __ast_callerid_generate(buf, name, number, ddn, redirecting, pres, qualifier, format, 0, codec, tz);
}

int ast_callerid_callwaiting_full_tz_generate(unsigned char *buf, const char *name, const char *number,
const char *ddn, int redirecting, int pres, int qualifier, struct ast_format *codec, const char *tz)
{
/* Type II Caller ID (CWCID) only uses MDMF, so format isn't an argument */
return __ast_callerid_generate(buf, name, number, ddn, redirecting, pres, qualifier, CID_TYPE_MDMF, 1, codec, tz);
}

char *ast_callerid_merge(char *buf, int bufsiz, const char *name, const char *num, const char *unknown)
Expand Down

0 comments on commit c3b04a3

Please sign in to comment.