/*
** Copyright (c) 2002 D. Richard Hipp
**
** 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.
**
** 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 library; if not, write to the
** Free Software Foundation, Inc., 59 Temple Place - Suite 330,
** Boston, MA 02111-1307, USA.
**
** Author contact information:
** drh@hwaci.com
** http://www.hwaci.com/drh/
**
*******************************************************************************
**
** Routines shared by many pages
*/
#include "config.h"
#include "common.h"
/*
** Output a string with the following substitutions:
**
** %T The title of the current page.
** %N Project name
** %V CVSTrac version number
** %B Base URL
** %% The character '%'
*/
static void output_with_subst(const char *zText, const char *zTitle){
int i;
while( zText[0] ){
for(i=0; zText[i] && zText[i]!='%'; i++){}
if( i>0 ) cgi_append_content(zText, i);
if( zText[i]==0 ) break;
switch( zText[i+1] ){
case 'T':
zText += i+2;
cgi_printf("%h", zTitle);
break;
case 'N':
zText += i+2;
cgi_printf("%h", g.zName);
break;
case 'V':
zText += i+2;
cgi_printf("%h", "2.0.0");
break;
case 'B':
zText += i+2;
cgi_printf("%h", g.zBaseURL);
break;
case '%':
zText += i+2;
cgi_printf("%%");
break;
default:
zText += i+1;
cgi_printf("%%");
break;
}
}
}
/*
** Read the whole contents of a file into memory obtained from
** malloc(). Return a pointer to the file contents. Be sure
** the string is null terminated.
**
** A NULL pointer is returned if the file could not be read
** for any reason.
*/
char *common_readfile(const char *zFilename) {
FILE *fp;
char *zContent = NULL;
size_t n;
if ((fp = fopen(zFilename, "r")) != NULL) {
fseek(fp, 0, SEEK_END);
if ((n = ftell(fp)) > 0) {
if ((zContent = (char *)malloc(n+1)) == NULL) {
fclose(fp);
return NULL;
}
fseek(fp, 0, SEEK_SET);
if ((n = fread(zContent, 1, n, fp)) == 0) {
free(zContent);
fclose(fp);
return NULL;
}
zContent[n] = '\0';
}
else {
zContent = strdup("");
}
fclose(fp);
}
return zContent;
}
/*
** Read the whole contents of a file pointer into memory obtained from
** malloc(). Return a pointer to the file contents. Be sure
** the string is null terminated.
**
** A NULL pointer is returned if the file could not be read
** for any reason. The caller is responsible for closing the file.
*/
char *common_readfp(FILE* fp) {
char *zContent = NULL;
char *z;
size_t n = 0, m = 0;
size_t rc;
while( fp && !feof(fp) && !ferror(fp) ) {
if( (n+1)>=m ){
m = m ? (m*2) : 1024;
z = realloc(zContent, m);
if( z==NULL ){
if( zContent!=NULL ) free(zContent);
return NULL;
}
zContent = z;
}
rc = fread(&zContent[n], 1, m-(n+1), fp);
if( rc>0 ){
n += rc;
}
zContent[n] = 0;
}
return zContent;
}
/*
** Generate an error message screen.
*/
void common_err(const char *zFormat, ...){
char *zMsg;
va_list ap;
va_start(ap, zFormat);
zMsg = vmprintf(zFormat, ap);
va_end(ap);
cgi_reset_content();
common_standard_menu(0,0);
common_header("Oops!");
cgi_printf("<p>The following error has occurred:</p>\n"
"<blockquote>%h</blockquote>\n",zMsg);
if( g.okSetup ){
cgi_printf("<p>Query parameters:<p>\n");
cgi_print_all();
}
common_footer();
cgi_append_header("Pragma: no-cache\r\n");
cgi_reply();
exit(0);
}
/*
** The menu on the top bar of every page is defined by the following
** variables. Links are navigation links to other pages. Actions are
** links which apply to the current page.
*/
static const char *azLink[50];
static int nLink = 0;
static const char *azAction[50];
static int nAction = 0;
const char *default_browse_url(void){
if( !strncmp(g.zPath,"dir",3) ) {
/* If the _current_ path is already a browse path, go with it */
return g.zPath;
}else{
/* If cookie is set, it overrides default setting */
char *zBrowseUrlCookieName = mprintf("%t_browse_url",g.zName);
const char *zCookieValue = P(zBrowseUrlCookieName);
free(zBrowseUrlCookieName);
if( zCookieValue ) {
if( !strcmp("dir",zCookieValue) ){
return "dir";
}else if( !strcmp("dirview",zCookieValue) ){
return "dirview";
}
}
}
return db_config("default_browse_url","dir");
}
/*
** Prepopulate the set of navigation items with a standard set that includes
** links to all top-level pages except for zOmit. If zOmit is NULL then
** include all items.
**
** If zSrchUrl is not NULL then use it as the URL for the "Search" menu
** option.
*/
void common_standard_menu(const char *zOmit, const char *zSrchUrl){
const char *zLimit;
if( g.okNewTkt ){
azLink[nLink++] = "tktnew";
azLink[nLink++] = "Ticket";
}
if( g.okCheckout ){
azLink[nLink++] = default_browse_url();
azLink[nLink++] = "Browse";
}
if( g.okRead ){
azLink[nLink++] = "reportlist";
azLink[nLink++] = "Reports";
}
if( g.okRdWiki || g.okRead || g.okCheckout ){
azLink[nLink++] = "timeline";
azLink[nLink++] = "Timeline";
}
if( g.okRdWiki ){
azLink[nLink++] = "wiki";
azLink[nLink++] = "Wiki";
}
if( g.okRdWiki || g.okRead || g.okCheckout ){
azLink[nLink++] = zSrchUrl ? zSrchUrl : "search";
azLink[nLink++] = "Search";
}
if( g.okCheckin ){
azLink[nLink++] = "msnew";
azLink[nLink++] = "Milestone";
}
if( g.okWrite && !g.isAnon ){
azLink[nLink++] = "userlist";
azLink[nLink++] = "Users";
}
if( g.okAdmin ){
azLink[nLink++] = "setup";
azLink[nLink++] = "Setup";
}
azLink[nLink++] = "login";
if( g.isAnon ){
azLink[nLink++] = "Login";
}else{
azLink[nLink++] = "Logout";
}
if( g.isAnon && (zLimit = db_config("throttle",0))!=0 && atof(zLimit)>0.0 ){
azLink[nLink++] = "honeypot";
azLink[nLink++] = "0Honeypot";
}
if( nLink>2 ){
azLink[nLink++] = "index";
azLink[nLink++] = "Home";
}
if( zOmit ){
int j;
for(j=0; j<nLink; j+=2){
if( azLink[j][0]==zOmit[0] && strcmp(zOmit,azLink[j])==0 ){
azLink[j] = azLink[nLink-2];
azLink[j+1] = azLink[nLink-1];
nLink -= 2;
break;
}
}
}
azLink[nLink] = 0;
}
/*
** Add a new navigation entry to the menu that will appear at the top of the
** page. zUrl is the URL that we jump to when the user clicks on
** the link and zName is the text that appears in the link.
*/
void common_add_nav_item(
const char *zUrl, /* The URL to be appended */
const char *zName /* The menu entry name */
){
azLink[nLink++] = zUrl;
azLink[nLink++] = zName;
azLink[nLink] = 0;
}
/*
** Add a new action entry to the menu that will appear at the top of the
** page. zUrl is the URL that we jump to when the user clicks on
** the link and zName is the text that appears in the link.
*/
void common_add_action_item(
const char *zUrl, /* The URL to be appended */
const char *zName /* The menu entry name */
){
azAction[nAction++] = zUrl;
azAction[nAction++] = zName;
azAction[nAction] = 0;
}
/*
** Add a "help" link to a specific Wiki page. Currently, we place the help
** link in the "link" section rather than "action" section, although arguably
** it's context dependent. However, there should be a help link on pretty much
** any page, so...
*/
void common_add_help_item(
const char *zWikiPage /* name of the help page */
){
if( g.okRdWiki
&& db_exists("SELECT 1 FROM wiki WHERE name='%q'", zWikiPage)){
azLink[nLink++] = mprintf("wiki?p=%s", zWikiPage);
azLink[nLink++] = "Help";
azLink[nLink] = 0;
}
}
/*
** Replace an existing navigation item with the new version given here.
** We don't have a corresponding function for the action menu since it's
** never prepopulated.
*/
void common_replace_nav_item(
const char *zUrl, /* The new URL */
const char *zName /* The menu entry name to be replaced */
){
int i;
for(i=0; i<nLink; i+=2){
if( strcmp(azLink[i+1],zName)==0 ){
if( zUrl==0 ){
azLink[i] = azLink[nLink-2];
azLink[i+1] = azLink[nLink-1];
nLink--;
}else{
azLink[i] = zUrl;
}
break;
}
}
}
/*
** Function used for sorting entries in azLinks[]
*/
static int link_compare(const void *a, const void *b){
const char **pA = (const char **)a;
const char **pB = (const char **)b;
return strcmp(pA[1], pB[1]);
}
/*
** Generate an HTML header common to all web pages. zTitle is the
** title for the page, zUrl (optional) is the link for that title.
** azLink is an array of URI/Name pairs that
** are used to generate navigation quick-links on the title bar. azAction
** is an array of context-dependent actions applicable to the current page.
*/
void common_vlink_header(const char *zUrl, const char *zTitle, va_list ap){
int i = 0;
int brk;
const char *zHeader = 0;
char *zTitleTxt;
zTitleTxt = vmprintf(zTitle, ap);
zHeader = db_config("header", HEADER);
if( zHeader && zHeader[0] ){
char *z;
if( zHeader[0]=='/' && (z = common_readfile(zHeader))!=0 ){
zHeader = z;
}
output_with_subst(zHeader, zTitleTxt);
}else{
output_with_subst(HEADER, zTitleTxt);
}
cgi_printf("<table width=\"100%%\" cellpadding=2 border=0>\n"
"<tr><td bgcolor=\"%s\" class=\"border1\">\n"
"<table width=\"100%%\" border=0 cellpadding=2 cellspacing=0>\n"
"<tr bgcolor=\"%s\" class=\"bkgnd1\">\n"
"<td valign=\"top\" align=\"left\">\n",BORDER1,BG1);
if( zUrl ){
cgi_printf("<big><b>%h -\n"
"<a rel=\"nofollow\" href=\"%h\">%h</a></b></big><br>\n",g.zName,zUrl,zTitleTxt);
}else{
cgi_printf("<big><b>%h - %h</b></big><br>\n",g.zName,zTitleTxt);
}
if( !g.isAnon ){
cgi_printf("<small><a href=\"logout\" title=\"Logout %h\">Logged in</a> as\n",g.zUser);
if( !strcmp(g.zUser,"setup") ){
cgi_printf("setup\n");
}else{
cgi_printf("<a href=\"wiki?p=%T\">%h</a>\n",g.zUser,g.zUser);
}
cgi_printf("</small>\n");
}else{
const char *zUri = getenv("REQUEST_URI");
cgi_printf("<a href=\"honeypot\"><small><notatag arg=\"meaningless\"></small></a>\n"
"<small><a href=\"login?nxp=%T\" title=\"Log in\">Not logged in</a></small>\n",zUri);
}
cgi_printf("</td>\n"
"<td valign=\"bottom\" align=\"right\">\n");
if( nLink && azLink ){
int j;
int nChar;
nLink /= 2;
qsort(azLink, nLink, 2*sizeof(azLink[0]), link_compare);
nChar = 0;
for(i=0; azLink[i]; i+=2){
nChar += strlen(azLink[i+1]) + 3;
}
if( nChar<=60 ){
brk = nChar;
}else if( nChar<=120 ){
brk = nChar/2;
}else{
brk = nChar/3;
}
nChar = 0;
cgi_printf("<nobr>\n");
for(i=0, j=1; azLink[i] && azLink[i+1]; i+=2, j++){
const char *z = azLink[i+1];
if( z[0]<'A' ) z++;
cgi_printf("[<a href=\"%h\">%h</a>] \n",azLink[i],z);
nChar += strlen(azLink[i+1]) + 3;
if( nChar>=brk && azLink[i+2] ){
nChar = 0;
cgi_printf("</nobr><br><nobr>\n");
}
}
cgi_printf("</nobr>\n");
}
if( i==0 ){
cgi_printf(" \n");
}
cgi_printf("</td></tr>\n");
if( nAction && azAction ){
int j;
int nChar;
cgi_printf("<tr bgcolor=\"%s\" class=\"bkgnd4\">\n"
"<td> </td>\n"
"<td valign=\"bottom\" align=\"right\">\n",BG4);
nAction /= 2;
qsort(azAction, nAction, 2*sizeof(azAction[0]), link_compare);
nChar = 0;
for(i=0; azAction[i]; i+=2){
nChar += strlen(azAction[i+1]) + 3;
}
if( nChar<=60 ){
brk = nChar;
}else if( nChar<=120 ){
brk = nChar/2;
}else{
brk = nChar/3;
}
nChar = 0;
cgi_printf("<nobr>\n");
for(i=0, j=1; azAction[i] && azAction[i+1]; i+=2, j++){
const char *z = azAction[i+1];
if( z[0]<'A' ) z++;
cgi_printf("[<a href=\"%h\" rel=\"nofollow\">%h</a>] \n",azAction[i],z);
nChar += strlen(azAction[i+1]) + 3;
if( nChar>=brk && azAction[i+2] ){
nChar = 0;
cgi_printf("</nobr><br><nobr>\n");
}
}
cgi_printf("</nobr>\n");
if( i==0 ){
cgi_printf(" \n");
}
cgi_printf("</td></tr>\n");
}
cgi_printf("</table>\n"
"</td></tr></table>\n"
"<div id=\"body\">\n");
free(zTitleTxt);
}
/*
** Generate an HTML header common to all web pages. zTitle is the
** title for the page, zUrl (optional) is the link for that title.
*/
void common_link_header(const char *zUrl, const char *zTitle,...){
va_list ap;
va_start(ap,zTitle);
assert(zUrl != NULL);
common_vlink_header(zUrl,zTitle,ap);
va_end(ap);
}
/*
** Generate an HTML header common to all web pages. zTitle is the
** title for the page.
*/
void common_header(const char *zTitle,...){
va_list ap;
va_start(ap,zTitle);
common_vlink_header(NULL,zTitle,ap);
va_end(ap);
}
/*
** Generate a common footer
*/
void common_footer(void){
const char *zFooter;
cgi_printf("</div>\n");
zFooter = db_config("footer", FOOTER);
if( zFooter && zFooter[0] ){
char *z;
if( zFooter[0]=='/' && (z = common_readfile(zFooter))!=0 ){
zFooter = z;
}
output_with_subst(zFooter, "");
}else{
output_with_subst(FOOTER, "");
}
}
/*
** Generate an about screen
**
** WEBPAGE: /about
*/
void common_about(void){
login_check_credentials();
common_add_nav_item("index", "Home");
common_header("About This Server", azLink);
cgi_printf("<p>This website is implemented using CVSTrac version 2.0.0.</p>\n"
"\n"
"<p>CVSTrac implements a patch-set and\n"
"bug tracking system for %h.\n"
"For additional information, visit the CVSTrac homepage at</p>\n"
"<blockquote>\n"
"<a href=\"http://www.cvstrac.org/\">http://www.cvstrac.org/</a>\n"
"</blockquote>\n"
"\n"
"<p>Copyright © 2002-2006 <a href=\"mailto:drh@hwaci.com\">\n"
"D. Richard Hipp</a>.\n"
"The CVSTrac server is released under the terms of the GNU\n"
"<a href=\"http://www.gnu.org/copyleft/gpl.html\">\n"
"General Public License</a>.</p>\n",g.scm.zName);
common_footer();
}
/*
** Generate an "icon" using HTML entity characters (i.e. "gt" or
** numeric value like "#62").
*/
void common_icon(const char* zIcon){
/* use HTML 4.0 character entities to create symbolic "icons". However,
** it seems that some browsers (Konqueror, maybe Safari) don't support
** the full set of entities. Some compromises are made.
**
** These would all fit very nicely into the config table. Then this
** function could be reduced to just:
** z=db_config(zIcon,"•");
** @ %s(z)
*/
if( !strcmp(zIcon,"arrow") ){
cgi_printf("<font color=\"blue\">›</font>");
}else if( !strcmp(zIcon,"box") ){
cgi_printf("<font color=\"#007878\">¤</font>");
}else if( !strcmp(zIcon,"ck") ){
cgi_printf("<font color=\"green\">√</font>");
}else if( !strcmp(zIcon,"dia") ){
cgi_printf("<font color=\"orange\">♦</font>");
}else if( !strcmp(zIcon,"dot") ){
cgi_printf("<font color=\"blue\">•</font>");
}else if( !strcmp(zIcon,"ptr1") ){
cgi_printf("<font color=\"purple\">»</font>");
}else if( !strcmp(zIcon,"star") ){
cgi_printf("<font color=\"#8C80A300\">*</font>");
}else if( !strcmp(zIcon,"x") ){
cgi_printf("<font color=\"red\">×</font>");
}else if( !strcmp(zIcon,"del") ){
cgi_printf("<font color=\"red\">×</font>");
}else if( !strcmp(zIcon,"file") ){
cgi_printf("<font color=\"black\">•</font>");
}else if( !strcmp(zIcon,"dir") ){
cgi_printf("<font color=\"green\">»</font>");
}else if( !strcmp(zIcon,"backup") ){
cgi_printf("<font color=\"black\">«</font>");
}
}
syntax highlighted by Code2HTML, v. 0.9.1