Compare commits
12 Commits
XMLTO_Docu
...
js_ops_BRA
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5403cc1fbd | ||
|
|
ea8b7ae403 | ||
|
|
792da6f338 | ||
|
|
8f82414d4c | ||
|
|
ad93b6b9aa | ||
|
|
bf3132f22b | ||
|
|
66d0cd3091 | ||
|
|
d1186c4663 | ||
|
|
6b1115ec03 | ||
|
|
92c4bd320a | ||
|
|
f8c60c6777 | ||
|
|
bc0482fed5 |
2710
mozilla/cmd/winfe/mkfiles32/mozilla.mak
Normal file
2710
mozilla/cmd/winfe/mkfiles32/mozilla.mak
Normal file
File diff suppressed because it is too large
Load Diff
62
mozilla/include/jscookie.h
Normal file
62
mozilla/include/jscookie.h
Normal file
@@ -0,0 +1,62 @@
|
||||
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
/*
|
||||
jscookie.h -- javascript reflection of cookies for filters.
|
||||
Created: Frederick G.M. Roeber <roeber@netscape.com>, 12-Jul-97.
|
||||
Adopted: Judson Valeski, 1997
|
||||
*/
|
||||
|
||||
#ifndef _JSCOOKIE_H_
|
||||
#define _JSCOOKIE_H_
|
||||
|
||||
typedef enum {
|
||||
JSCF_accept,
|
||||
JSCF_reject,
|
||||
JSCF_ask,
|
||||
JSCF_whatever,
|
||||
JSCF_error
|
||||
}
|
||||
JSCFResult;
|
||||
|
||||
typedef struct {
|
||||
char *path_from_header;
|
||||
char *host_from_header;
|
||||
char *name_from_header;
|
||||
char *cookie_from_header;
|
||||
time_t expires;
|
||||
char *url;
|
||||
Bool secure;
|
||||
Bool domain;
|
||||
Bool prompt; /* the preference */
|
||||
NET_CookieBehaviorEnum preference;
|
||||
}
|
||||
JSCFCookieData;
|
||||
|
||||
extern JSCFResult JSCF_Execute(
|
||||
MWContext *mwcontext,
|
||||
const char *script_name,
|
||||
JSCFCookieData *data,
|
||||
Bool *data_changed
|
||||
);
|
||||
|
||||
/* runs the garbage collector on the filter context. Probably a good
|
||||
idea to call on completion of NET_GetURL or something. */
|
||||
extern void JSCF_Cleanup(void);
|
||||
|
||||
#endif /* _JSCOOKIE_H_ */
|
||||
|
||||
755
mozilla/include/libevent.h
Normal file
755
mozilla/include/libevent.h
Normal file
@@ -0,0 +1,755 @@
|
||||
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Header file for event passing between the mozilla thread and
|
||||
* the mocha thread
|
||||
*/
|
||||
|
||||
#ifndef libevent_h___
|
||||
#define libevent_h___
|
||||
|
||||
#include "libmocha.h"
|
||||
#include "prtypes.h"
|
||||
#ifndef NSPR20
|
||||
#include "prevent.h"
|
||||
#else
|
||||
#include "plevent.h"
|
||||
#endif
|
||||
#include "shist.h"
|
||||
#include "fe_proto.h"
|
||||
#include "lo_ele.h"
|
||||
#include "jscookie.h"
|
||||
|
||||
NSPR_BEGIN_EXTERN_C
|
||||
|
||||
extern PREventQueue * mozilla_event_queue;
|
||||
|
||||
typedef struct WindowGroup LMWindowGroup;
|
||||
|
||||
/*
|
||||
* XXX - should we use the same event values as layer events?
|
||||
*/
|
||||
|
||||
/* Event bits stored in the low end of decoder->event_mask. */
|
||||
#define EVENT_MOUSEDOWN 0x00000001
|
||||
#define EVENT_MOUSEUP 0x00000002
|
||||
#define EVENT_MOUSEOVER 0x00000004 /* user is mousing over a link */
|
||||
#define EVENT_MOUSEOUT 0x00000008 /* user is mousing out of a link */
|
||||
#define EVENT_MOUSEMOVE 0x00000010
|
||||
#define EVENT_MOUSEDRAG 0x00000020
|
||||
#define EVENT_CLICK 0x00000040 /* input element click in progress */
|
||||
#define EVENT_DBLCLICK 0x00000080
|
||||
#define EVENT_KEYDOWN 0x00000100
|
||||
#define EVENT_KEYUP 0x00000200
|
||||
#define EVENT_KEYPRESS 0x00000400
|
||||
#define EVENT_DRAGDROP 0x00000800 /* not yet implemented */
|
||||
#define EVENT_FOCUS 0x00001000 /* input focus event in progress */
|
||||
#define EVENT_BLUR 0x00002000 /* loss of focus event in progress */
|
||||
#define EVENT_SELECT 0x00004000 /* input field selection in progress */
|
||||
#define EVENT_CHANGE 0x00008000 /* field value change in progress */
|
||||
#define EVENT_RESET 0x00010000 /* form submit in progress */
|
||||
#define EVENT_SUBMIT 0x00020000 /* form submit in progress */
|
||||
#define EVENT_SCROLL 0x00040000 /* window is being scrolled */
|
||||
#define EVENT_LOAD 0x00080000 /* layout parsed a loaded document */
|
||||
#define EVENT_UNLOAD 0x00100000
|
||||
#define EVENT_XFER_DONE 0x00200000 /* document has loaded */
|
||||
#define EVENT_ABORT 0x00400000
|
||||
#define EVENT_ERROR 0x00800000
|
||||
#define EVENT_LOCATE 0x01000000
|
||||
#define EVENT_MOVE 0x02000000
|
||||
#define EVENT_RESIZE 0x04000000
|
||||
#define EVENT_FORWARD 0x08000000
|
||||
#define EVENT_HELP 0x10000000 /* for handling of help events */
|
||||
#define EVENT_BACK 0x20000000
|
||||
|
||||
/* #define EVENT_PRINT 0x20000000 *//* To be removed per joki */
|
||||
|
||||
#define STATUS_STOP 0x00000001 /* stop processing */
|
||||
#define STATUS_IGNORE 0x00000002 /* no new messages */
|
||||
|
||||
#define EVENT_ALT_MASK 0x00000001
|
||||
#define EVENT_CONTROL_MASK 0x00000002
|
||||
#define EVENT_SHIFT_MASK 0x00000004
|
||||
#define EVENT_META_MASK 0x00000008
|
||||
|
||||
#define ARGTYPE_NULL 0x00000001
|
||||
#define ARGTYPE_INT32 0x00000002
|
||||
#define ARGTYPE_BOOL 0x00000004
|
||||
#define ARGTYPE_STRING 0x00000008
|
||||
|
||||
#define SIZE_MAX 0x00000001
|
||||
#define SIZE_MIN 0X00000002
|
||||
/*
|
||||
* When the event has been processed by the backend, there will be
|
||||
* a front-end callback that gets called. If the event processed
|
||||
* successfully, the callback will be passed EVENT_OK. If the
|
||||
* event wasn't successful (i.e. the user canceled it) the return
|
||||
* status will be EVENT_CANCEL. If something radical happened
|
||||
* and the front-end should do nothing (i.e. mocha changed the
|
||||
* underlying context) the status will be EVENT_PANIC and the
|
||||
* front end should treat the context and element passed to the
|
||||
* exit routine as bogus
|
||||
*/
|
||||
typedef enum {
|
||||
EVENT_OK,
|
||||
EVENT_CANCEL,
|
||||
EVENT_PANIC
|
||||
} ETEventStatus;
|
||||
|
||||
/*
|
||||
* When a given event gets processed we may need to tell the front
|
||||
* end about it so that they can update the UI / continue the
|
||||
* operation. The context, lo_element, lType and whatever
|
||||
* field are all supplied by the original ET_SendEvent() call.
|
||||
* See ET_SendEvent() for a description of the values for
|
||||
* the status parameter
|
||||
*/
|
||||
typedef void
|
||||
(*ETClosureFunc)(MWContext * pContext, LO_Element * lo_element,
|
||||
int32 lType, void * whatever, ETEventStatus status);
|
||||
|
||||
/*
|
||||
* Someone has initiated a call to LM_EvaluateBuffer(). This function
|
||||
* gets called back with the result
|
||||
*/
|
||||
typedef void
|
||||
(*ETEvalAckFunc)(void * data, char * result_string, size_t result_length,
|
||||
char * wysiwyg_url, char * base_href, Bool valid);
|
||||
|
||||
/*
|
||||
* This function is called back after a layer's state has been restored
|
||||
* in a resize_relayout.
|
||||
*/
|
||||
typedef void
|
||||
(*ETRestoreAckFunc)(void * data, LO_BlockInitializeStruct *param);
|
||||
|
||||
/*
|
||||
* Typedef for a function taking a void pointer and
|
||||
* returning nothing
|
||||
*/
|
||||
typedef void
|
||||
(*ETVoidPtrFunc)(void * data);
|
||||
|
||||
/*
|
||||
* Typedef for a function taking a void pointer and
|
||||
* returning a bool
|
||||
*/
|
||||
typedef PRBool
|
||||
(*ETBoolPtrFunc)(void * data);
|
||||
|
||||
/*
|
||||
* Typedef for a function taking a void pointer and
|
||||
* returning a int32
|
||||
*/
|
||||
typedef int32
|
||||
(*ETIntPtrFunc)(void * data);
|
||||
|
||||
/*
|
||||
* Typedef for a function taking a void pointer and
|
||||
* returning a char *
|
||||
*/
|
||||
typedef char *
|
||||
(*ETStringPtrFunc)(void * data);
|
||||
|
||||
/*
|
||||
* Struct for passing JS typed variable info through C interface calls
|
||||
*/
|
||||
typedef union ArgVal {
|
||||
int32 intArg;
|
||||
XP_Bool boolArg;
|
||||
char * stringArg;
|
||||
} ArgVal;
|
||||
|
||||
typedef struct {
|
||||
uint8 type; /* arg type as defined at top of file */
|
||||
ArgVal value;
|
||||
} JSCompArg;
|
||||
|
||||
/*
|
||||
* Typedef for a function used to verify installed components and
|
||||
* get back components utility functions.
|
||||
*/
|
||||
typedef PRBool
|
||||
(*ETVerifyComponentFunc)(void **active_callback, void **startup_callback);
|
||||
|
||||
/*
|
||||
* Generic function for JS setting values with native calls.
|
||||
*/
|
||||
typedef void
|
||||
(*ETCompPropSetterFunc)(char *name, void *value);
|
||||
|
||||
/*
|
||||
* Generic function for JS getting values from native calls.
|
||||
*/
|
||||
typedef void*
|
||||
(*ETCompPropGetterFunc)(char *name);
|
||||
|
||||
/*
|
||||
* Generic function for JS calling native methods.
|
||||
*/
|
||||
typedef void*
|
||||
(*ETCompMethodFunc)(int32 argc, JSCompArg *argv);
|
||||
|
||||
/* --------------------------------------------------------------------------
|
||||
* Common prologue for talking between the mocha thread and the mozilla
|
||||
* thread
|
||||
*/
|
||||
typedef struct {
|
||||
PREvent event; /* the PREvent structure */
|
||||
MWContext* context; /* context */
|
||||
int32 doc_id; /* doc id of context when event launched */
|
||||
PRPackedBool handle_eagerly;
|
||||
} ETEvent;
|
||||
|
||||
/*
|
||||
* Struct to send back from front end in order to get additional
|
||||
* event information without having to initialize event object
|
||||
* until necessary. Yow, there is a lot of junk in here now
|
||||
* can we make a union out of some of these or are they always
|
||||
* needed?
|
||||
*/
|
||||
typedef struct {
|
||||
ETEvent ce;
|
||||
MochaDecoder * decoder;
|
||||
JSObject * object;
|
||||
int32 type;
|
||||
int32 layer_id;
|
||||
int32 id;
|
||||
LO_Element * lo_element;
|
||||
ETClosureFunc fnClosure; /* event sender closure */
|
||||
void * whatever; /* anything other state */
|
||||
int32 x,y;
|
||||
int32 docx,docy;
|
||||
int32 screenx,screeny;
|
||||
uint32 which;
|
||||
uint32 modifiers;
|
||||
void * data;
|
||||
uint32 dataSize;
|
||||
PRPackedBool saved;
|
||||
PRPackedBool event_handled;
|
||||
} JSEvent;
|
||||
|
||||
/*
|
||||
* Tell the backend about a new event.
|
||||
* The event is placed onto an event queue, it is not processed
|
||||
* immediately. If the event is the type that can be cancelled
|
||||
* by the backend (i.e. a button click or a submit) the front
|
||||
* end must wait until the callback routine gets called before
|
||||
* continuing with the operation. The ETEventStatus will be
|
||||
* EVENT_OK if the operation is to continue or EVENT_CANCEL
|
||||
* if it got cancelled.
|
||||
*
|
||||
* The processing of the event may cause the document to change
|
||||
* or even the whole window to close. In those cases the callback
|
||||
* will still get called in case there is any front-end cleanup
|
||||
* to do but the ETEventStatus will be set to EVENT_PANIC
|
||||
*
|
||||
*/
|
||||
|
||||
extern JSBool
|
||||
ET_SendEvent(MWContext * pContext, LO_Element *pElement, JSEvent *pEvent,
|
||||
ETClosureFunc fnClosure, void * whatever);
|
||||
|
||||
/*
|
||||
* Tell the backend about a new document load event. We need a
|
||||
* closure so that libparse/layout knows when its safe to discard
|
||||
* the old document when they were waiting for onunload events to
|
||||
* finish processing
|
||||
*/
|
||||
extern void
|
||||
ET_SendLoadEvent(MWContext * pContext, int32 type, ETVoidPtrFunc fnClosure,
|
||||
NET_StreamClass *stream, int32 layer_id, Bool resize_reload);
|
||||
|
||||
/*
|
||||
* Tell the backend about a new image event. Async. No closure
|
||||
*/
|
||||
extern void
|
||||
ET_SendImageEvent(MWContext * pContext, LO_ImageStruct *image_data,
|
||||
LM_ImageEvent event);
|
||||
|
||||
/*
|
||||
* Send an interrupt event to the current context
|
||||
* Remove all pending events for the event queue of the given context.
|
||||
*/
|
||||
extern void
|
||||
ET_InterruptContext(MWContext * pContext);
|
||||
|
||||
extern JSBool
|
||||
ET_ContinueProcessing(MWContext * pContext);
|
||||
|
||||
/*
|
||||
* Tell mocha to destroy the given context's data. The callback
|
||||
* function gets called when mocha is done with all of its data
|
||||
* that was associated with the context
|
||||
*/
|
||||
extern void
|
||||
ET_RemoveWindowContext(MWContext * context, ETVoidPtrFunc fn,
|
||||
void * data);
|
||||
|
||||
typedef struct {
|
||||
uint len, line_no;
|
||||
char * scope_to;
|
||||
void * data;
|
||||
JSVersion version;
|
||||
JSPrincipals * principals;
|
||||
JSBool want_result;
|
||||
JSBool unicode;
|
||||
} ETEvalStuff;
|
||||
|
||||
/*
|
||||
* Evaluate the mocha code in the given buffer
|
||||
*/
|
||||
extern void
|
||||
ET_EvaluateBuffer(MWContext * context, char * buffer, uint buflen,
|
||||
uint line_no, char * scope_to, JSBool want_result,
|
||||
ETEvalAckFunc fn, void * data,
|
||||
JSVersion ver, struct JSPrincipals *);
|
||||
|
||||
extern void
|
||||
ET_EvaluateScript(MWContext * context, char * buffer, ETEvalStuff * stuff,
|
||||
ETEvalAckFunc fn);
|
||||
|
||||
/*
|
||||
* Ask Mocha to reflect the given object into JavaScript
|
||||
*/
|
||||
extern void
|
||||
ET_ReflectObject(MWContext * pContext, void * lo_ele, void * tag,
|
||||
int32 layer_id, uint index, ReflectedObject type);
|
||||
|
||||
void
|
||||
ET_ReflectFormElement(MWContext * pContext, void * form,
|
||||
LO_FormElementStruct * form_element, PA_Tag * tag);
|
||||
|
||||
extern void
|
||||
ET_ReflectWindow(MWContext * pContext,
|
||||
PA_Block onLoad, PA_Block onUnload,
|
||||
PA_Block onFocus, PA_Block onBlur, PA_Block onHelp,
|
||||
PA_Block onMouseOver, PA_Block onMouseOut, PA_Block onDragDrop,
|
||||
PA_Block onMove, PA_Block onResize,
|
||||
PA_Block id, char *all,
|
||||
Bool bDelete, int newline_count);
|
||||
|
||||
/*
|
||||
* Tell mocha we are processing a form
|
||||
*/
|
||||
extern void
|
||||
ET_SetActiveForm(MWContext * pContext, struct lo_FormData_struct * loElement);
|
||||
|
||||
/*
|
||||
* Tell mocha which layer we are processing
|
||||
*/
|
||||
void
|
||||
ET_SetActiveLayer(MWContext * pContext, int32 layer_id);
|
||||
|
||||
/*
|
||||
** Tell mocha where to send its output
|
||||
*/
|
||||
extern void
|
||||
ET_ClearDecoderStream(MWContext * context, NET_StreamClass * old_stream);
|
||||
|
||||
extern void
|
||||
ET_SetDecoderStream(MWContext * context, NET_StreamClass *stream,
|
||||
URL_Struct *url_struct, JSBool free_stream_on_close);
|
||||
|
||||
/*
|
||||
** Remember the current nesting URL in the MochaDecoder
|
||||
*/
|
||||
extern void
|
||||
ET_SetNestingUrl(MWContext * context, char * szUrl);
|
||||
|
||||
/*
|
||||
** Remember the current language version in the MochaDecoder
|
||||
*/
|
||||
extern void
|
||||
ET_SetVersion(MWContext * context, JSVersion version);
|
||||
|
||||
/*
|
||||
* Tell mocha to trash the current document. around and around...
|
||||
*/
|
||||
extern void
|
||||
ET_ReleaseDocument(MWContext * pContext, JSBool resize_reload);
|
||||
|
||||
/*
|
||||
* Tell mocha to trash the layer's document.
|
||||
*/
|
||||
extern void
|
||||
ET_DestroyLayer(MWContext * pContext, JSObject *layer_obj);
|
||||
|
||||
extern void
|
||||
ET_MochaStreamComplete(MWContext * context, void * buf, int len,
|
||||
char * content_type, Bool isUnicode);
|
||||
|
||||
extern void
|
||||
ET_MochaStreamAbort(MWContext * context, int status);
|
||||
|
||||
/*
|
||||
* Called when a layer's contents are changing and we want to create
|
||||
* a new layer document.
|
||||
*/
|
||||
extern void
|
||||
ET_NewLayerDocument(MWContext *pContext, int32 layer_id);
|
||||
|
||||
extern void
|
||||
ET_DocWriteAck(MWContext *pContext, int status);
|
||||
|
||||
extern void
|
||||
ET_RegisterComponent(char *name, void *active_callback, void *startup_callback);
|
||||
|
||||
extern void
|
||||
ET_RegisterComponentProp(char *comp, char *name, uint8 retType, void *setter,
|
||||
void *getter);
|
||||
|
||||
extern void
|
||||
ET_RegisterComponentMethod(char *comp, char *name, uint8 retType, void *method,
|
||||
int32 argc);
|
||||
|
||||
/* =============================================================== */
|
||||
|
||||
/*
|
||||
* This event can be sent to both the mozilla thread and the moacha thread
|
||||
*/
|
||||
typedef struct {
|
||||
ETEvent ce;
|
||||
TimeoutCallbackFunction fnCallback;
|
||||
void* pClosure;
|
||||
uint32 ulTime;
|
||||
void* pTimerId;
|
||||
} MozillaEvent_Timeout;
|
||||
|
||||
|
||||
/* =============================================================== */
|
||||
|
||||
/*
|
||||
* Busy loop waiting for events to come along
|
||||
*/
|
||||
extern void PR_CALLBACK
|
||||
lm_wait_for_events(void *);
|
||||
|
||||
/*
|
||||
* global mocha event queues. It would be nice to not have these
|
||||
* exported this globally
|
||||
*/
|
||||
extern PREventQueue *lm_InterpretQueue;
|
||||
extern PREventQueue *lm_PriorityQueue;
|
||||
|
||||
/*
|
||||
* Ways to send events to the front end
|
||||
*/
|
||||
extern JSBool
|
||||
ET_PostMessageBox(MWContext* context, char* szMessage,
|
||||
JSBool bConfirm);
|
||||
|
||||
extern void
|
||||
ET_PostProgress(MWContext* context, const char* szMessage);
|
||||
|
||||
/* --- timeout routines --- */
|
||||
|
||||
/*
|
||||
* Set (or clear) a timeout to go off. The timeout will go off in the
|
||||
* mozilla thread so we will use the routine ET_FireTimeoutCallBack()
|
||||
* to get back into our thread to actually run the closure
|
||||
*/
|
||||
extern void *
|
||||
ET_PostSetTimeout(TimeoutCallbackFunction fnCallback,
|
||||
void * pClosure, uint32 ulTime, int32 doc_id);
|
||||
|
||||
extern void
|
||||
ET_PostClearTimeout(void * stuff);
|
||||
|
||||
extern void
|
||||
ET_FireTimeoutCallBack(void *);
|
||||
|
||||
/* --- end of timeout routines --- */
|
||||
|
||||
extern void
|
||||
ET_PostDestroyWindow(MWContext * context);
|
||||
|
||||
extern void
|
||||
ET_PostManipulateForm(MWContext * context, LO_Element * pForm, int32 action);
|
||||
|
||||
extern void
|
||||
ET_PostClearView(MWContext * context);
|
||||
|
||||
extern void
|
||||
ET_PostFreeImageElement(MWContext * context, void * stuff);
|
||||
|
||||
extern void
|
||||
ET_PostFreeImageContext(MWContext *context, IL_GroupContext *img_cx);
|
||||
|
||||
extern void
|
||||
ET_PostFreeAnonImages(MWContext *context, IL_GroupContext *img_cx);
|
||||
|
||||
extern void
|
||||
ET_PostDisplayImage(MWContext *, int, LO_ImageStruct *);
|
||||
|
||||
extern void
|
||||
ET_PostGetUrl(MWContext *, URL_Struct * pUrl);
|
||||
|
||||
extern char *
|
||||
ET_PostPrompt(MWContext* context, const char* szMessage,
|
||||
const char * szDefault);
|
||||
|
||||
extern MWContext *
|
||||
ET_PostNewWindow(MWContext* context, URL_Struct * pUrl,
|
||||
char * szName, Chrome * pChrome, LMWindowGroup *grp);
|
||||
|
||||
extern void
|
||||
ET_PostUpdateChrome(MWContext* context, Chrome * pChrome);
|
||||
|
||||
extern void
|
||||
ET_PostQueryChrome(MWContext* context, Chrome * pChrome);
|
||||
|
||||
extern void
|
||||
ET_PostGetScreenSize(MWContext* context, int32 *pX, int32 *pY);
|
||||
|
||||
extern void
|
||||
ET_PostGetAvailScreenRect(MWContext* context, int32 *pX, int32 *pY,
|
||||
int32 *pLeft, int32 *pTop);
|
||||
|
||||
extern void
|
||||
ET_PostGetColorDepth(MWContext* context, int32 *pPixel, int32 *pPallette);
|
||||
|
||||
extern char *
|
||||
ET_PostGetSelectedText(MWContext* context);
|
||||
|
||||
extern void
|
||||
ET_PostScrollDocTo(MWContext* context, int loc, int32 x, int32 y);
|
||||
|
||||
extern void
|
||||
ET_PostScrollDocBy(MWContext* context, int loc, int32 x, int32 y);
|
||||
|
||||
extern void
|
||||
ET_PostBackCommand(MWContext* context);
|
||||
|
||||
extern void
|
||||
ET_PostForwardCommand(MWContext* context);
|
||||
|
||||
extern void
|
||||
ET_PostHomeCommand(MWContext* context);
|
||||
|
||||
extern JSBool
|
||||
ET_PostFindCommand(MWContext* context, char * szName, JSBool matchCase,
|
||||
JSBool searchBackward);
|
||||
extern void
|
||||
ET_PostPrintCommand(MWContext* context);
|
||||
|
||||
extern void
|
||||
ET_PostOpenFileCommand(MWContext* context);
|
||||
|
||||
extern void
|
||||
ET_MakeHTMLAlert(MWContext * context, const char * szString);
|
||||
|
||||
/* respond to events sent to the mocha thread by the mozilla thread */
|
||||
|
||||
extern void
|
||||
ET_PostJsEventAck(MWContext* context, LO_Element * pEle, int type,
|
||||
ETClosureFunc fnClosure, void * pStuff,
|
||||
ETEventStatus status);
|
||||
|
||||
|
||||
|
||||
extern void
|
||||
ET_PostEvalAck(MWContext * context, int doc_id, void * data,
|
||||
char * str, size_t len, char * wysiwyg_url,
|
||||
char * base_href, Bool valid, ETEvalAckFunc fn);
|
||||
|
||||
extern void
|
||||
ET_PostRestoreAck(void *data, LO_BlockInitializeStruct *param,
|
||||
ETRestoreAckFunc fn);
|
||||
|
||||
/* netlib events */
|
||||
|
||||
extern char *
|
||||
ET_net_GetCookie(MWContext* context, int32 doc_id);
|
||||
|
||||
extern char *
|
||||
ET_net_SetCookieString(MWContext* context, char * szCookie, int32 doc_id);
|
||||
|
||||
extern NET_StreamClass *
|
||||
ET_net_CacheConverter(FO_Present_Types format, void * obj,
|
||||
URL_Struct *pUrl, MWContext * pContext);
|
||||
|
||||
extern void
|
||||
ET_net_FindURLInCache(URL_Struct * pUrl, MWContext * pContext);
|
||||
|
||||
extern NET_StreamClass *
|
||||
ET_net_StreamBuilder(FO_Present_Types format, URL_Struct *pUrl,
|
||||
MWContext * pContext);
|
||||
|
||||
/* layout events */
|
||||
|
||||
extern void
|
||||
ET_lo_ResetForm(MWContext * pContext, LO_Element * ele);
|
||||
|
||||
void
|
||||
ET_fe_SubmitInputElement(MWContext * pContext, LO_Element * ele);
|
||||
|
||||
/*
|
||||
* Synchronously shove the given text down the parser's processing
|
||||
* queue. If the currently loaded document is not equal to
|
||||
* doc_id, this message should be ignored since it arrived too
|
||||
* late for the intended document
|
||||
*/
|
||||
extern int
|
||||
ET_lo_DoDocWrite(JSContext *cx, MWContext * context, NET_StreamClass * stream,
|
||||
char * str, size_t len, int32 doc_id);
|
||||
|
||||
|
||||
extern void
|
||||
ET_il_GetImage(const char * str, MWContext * pContext, IL_GroupContext *img_cx,
|
||||
LO_ImageStruct * image_data, NET_ReloadMethod how);
|
||||
|
||||
extern void
|
||||
ET_il_SetGroupObserver(MWContext * pContext, IL_GroupContext *pImgCX, void *pDpyCX,
|
||||
JSBool bAddObserver);
|
||||
|
||||
extern void
|
||||
ET_InterruptImgCX(MWContext * pContext);
|
||||
|
||||
/*
|
||||
* Tell layout to trash the current document.
|
||||
*/
|
||||
extern void
|
||||
ET_lo_DiscardDocument(MWContext * pContext);
|
||||
|
||||
/*
|
||||
* Tell layout to prepare a layer for writing.
|
||||
*/
|
||||
extern Bool
|
||||
ET_lo_PrepareLayerForWriting(MWContext *context, int32 layer_id,
|
||||
const char *referer);
|
||||
|
||||
/*
|
||||
* Return a copy of the current history element. Caller must free
|
||||
*/
|
||||
extern History_entry *
|
||||
ET_shist_GetCurrent(MWContext * pContext);
|
||||
|
||||
/*
|
||||
* Return the current security status.
|
||||
*/
|
||||
extern int
|
||||
ET_GetSecurityStatus(MWContext * pContext);
|
||||
|
||||
/*
|
||||
* Make sure Mocha/Java glue is ready. Returns the same return code as
|
||||
* LM_InitMoja.
|
||||
*/
|
||||
extern int
|
||||
ET_InitMoja(MWContext * pContext);
|
||||
|
||||
/*
|
||||
* Pack up toys and go home
|
||||
*/
|
||||
extern void
|
||||
ET_FinishMocha(void);
|
||||
|
||||
/*
|
||||
* Used to call a stream completion function in the mozilla
|
||||
* thread
|
||||
*/
|
||||
extern void
|
||||
ET_moz_CallFunction(ETVoidPtrFunc fn, void * data);
|
||||
|
||||
extern void
|
||||
ET_moz_CallFunctionAsync(ETVoidPtrFunc fn, void * data);
|
||||
|
||||
extern PRBool
|
||||
ET_moz_CallFunctionBool(ETBoolPtrFunc fn, void * data);
|
||||
|
||||
extern int32
|
||||
ET_moz_CallFunctionInt(ETIntPtrFunc fn, void * data);
|
||||
|
||||
extern char *
|
||||
ET_moz_CallFunctionString(ETStringPtrFunc fn, void * data);
|
||||
|
||||
extern void
|
||||
ET_moz_CallAsyncAndSubEventLoop(ETVoidPtrFunc fn, void *data,
|
||||
MWContext *context);
|
||||
|
||||
extern void
|
||||
ET_moz_Abort(MKStreamAbortFunc fn, void * data, int status);
|
||||
|
||||
extern void
|
||||
ET_moz_SetMochaWriteStream(MochaDecoder * decoder);
|
||||
|
||||
extern NET_StreamClass *
|
||||
ET_moz_DocCacheConverter(MWContext * context, URL_Struct * pUrl,
|
||||
char * wysiwyg_url, int32 layer_id);
|
||||
|
||||
extern PRBool
|
||||
ET_moz_VerifyComponentFunction(ETVerifyComponentFunc fn, ETBoolPtrFunc *pActive_callback,
|
||||
ETVoidPtrFunc *pStartup_callback);
|
||||
|
||||
extern void
|
||||
ET_moz_CompSetterFunction(ETCompPropSetterFunc fn, char *name, void *data);
|
||||
|
||||
extern void *
|
||||
ET_moz_CompGetterFunction(ETCompPropGetterFunc fn, char *name);
|
||||
|
||||
extern void *
|
||||
ET_moz_CompMethodFunction(ETCompMethodFunc fn, int32 argc, JSCompArg *argv);
|
||||
|
||||
typedef enum {
|
||||
CL_Move,
|
||||
CL_MoveX,
|
||||
CL_MoveY,
|
||||
CL_Offset,
|
||||
CL_Resize,
|
||||
CL_SetBboxWidth,
|
||||
CL_SetBboxHeight,
|
||||
CL_SetBboxTop,
|
||||
CL_SetBboxLeft,
|
||||
CL_SetBboxBottom,
|
||||
CL_SetBboxRight,
|
||||
CL_SetHidden,
|
||||
CL_MoveInZ,
|
||||
CL_SetSrc,
|
||||
CL_SetSrcWidth,
|
||||
CL_SetZ,
|
||||
CL_SetBgColor,
|
||||
CL_SetBackdrop
|
||||
} ETLayerOp;
|
||||
|
||||
extern int
|
||||
ET_TweakLayer(MWContext * context, CL_Layer * layer, int32 x, int32 y,
|
||||
void *param_ptr, int32 param_val, ETLayerOp op,
|
||||
const char *referer, int32 doc_id);
|
||||
|
||||
extern void
|
||||
ET_RestoreLayerState(MWContext *context, int32 layer_id,
|
||||
LO_BlockInitializeStruct *param, ETRestoreAckFunc fn,
|
||||
void *data);
|
||||
|
||||
extern int32
|
||||
ET_npl_RefreshPluginList(MWContext* context, XP_Bool refreshInstances);
|
||||
|
||||
extern JSCFResult
|
||||
ET_JSCFExecute(MWContext *context, const char *script_name,
|
||||
JSCFCookieData *data, Bool *data_changed);
|
||||
|
||||
extern JSBool
|
||||
ET_HandlePref(JSContext * cx, uint argc, jsval * argv, jsval * rval);
|
||||
|
||||
extern void
|
||||
ET_SetPluginWindow(MWContext * pContext, void * app);
|
||||
|
||||
NSPR_END_EXTERN_C
|
||||
|
||||
#endif /* libevent_h___ */
|
||||
546
mozilla/include/libmocha.h
Normal file
546
mozilla/include/libmocha.h
Normal file
@@ -0,0 +1,546 @@
|
||||
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Header file for Mocha in the Navigator (libmocha).
|
||||
*/
|
||||
|
||||
#ifndef libmocha_h___
|
||||
#define libmocha_h___
|
||||
|
||||
#include "ntypes.h"
|
||||
#include "il_types.h"
|
||||
#include "prtypes.h"
|
||||
#include "plhash.h"
|
||||
#include "prthread.h"
|
||||
#include "jsapi.h"
|
||||
|
||||
/* enable JavaScript Debugger support */
|
||||
#if defined (_WIN32) || defined(XP_UNIX) || defined(powerc) || defined(__powerc) || defined(XP_OS2)
|
||||
#ifdef JAVA
|
||||
#define JSDEBUGGER 1
|
||||
#endif
|
||||
#endif
|
||||
|
||||
NSPR_BEGIN_EXTERN_C
|
||||
|
||||
typedef struct JSTimeout JSTimeout;
|
||||
typedef struct JSPrincipalsList JSPrincipalsList;
|
||||
typedef struct JSNestingUrl JSNestingUrl;
|
||||
|
||||
/*
|
||||
* There exists one MochaDecoder per top-level MWContext that decodes Mocha,
|
||||
* either from an HTML page or from a "mocha:[expr]" URL.
|
||||
*/
|
||||
typedef struct MochaDecoder {
|
||||
int32 forw_count; /* forward reference count */
|
||||
int32 back_count; /* back (up the tree) count */
|
||||
JSContext *js_context;
|
||||
MWContext *window_context;
|
||||
JSObject *window_object;
|
||||
NET_StreamClass *stream;
|
||||
int32 stream_owner; /* id of layer that's loading the stream */
|
||||
URL_Struct *url_struct;
|
||||
JSTimeout *timeouts;
|
||||
JSTimeout *saved_timeouts;
|
||||
uint16 signature_ordinal;
|
||||
PRPackedBool replace_location;
|
||||
PRPackedBool resize_reload;
|
||||
PRPackedBool load_event_sent;
|
||||
PRPackedBool visited;
|
||||
PRPackedBool writing_input;
|
||||
PRPackedBool free_stream_on_close;
|
||||
PRPackedBool in_window_quota;
|
||||
PRPackedBool called_win_close;
|
||||
PRPackedBool principals_compromised;
|
||||
const char *source_url;
|
||||
JSNestingUrl *nesting_url;
|
||||
uint32 error_count;
|
||||
uint32 event_mask;
|
||||
int32 active_layer_id;
|
||||
uint32 active_form_id;
|
||||
uint32 event_bit;
|
||||
int32 doc_id;
|
||||
|
||||
/*
|
||||
* Class prototype objects, in alphabetical order. Must be CLEARed (set
|
||||
* to null) in LM_PutMochaDecoder, HELD (GC roots added) in lm_NewWindow,
|
||||
* and DROPped (removed as GC roots) in lm_DestroyWindow.
|
||||
* XXXbe clean up, clear via bzero, using a sub-structure.
|
||||
*/
|
||||
JSObject *anchor_prototype;
|
||||
JSObject *bar_prototype;
|
||||
JSObject *document_prototype;
|
||||
JSObject *event_prototype;
|
||||
JSObject *event_capturer_prototype;
|
||||
JSObject *event_receiver_prototype;
|
||||
JSObject *form_prototype;
|
||||
JSObject *image_prototype;
|
||||
JSObject *input_prototype;
|
||||
JSObject *layer_prototype;
|
||||
JSObject *option_prototype;
|
||||
JSObject *rect_prototype;
|
||||
JSObject *url_prototype;
|
||||
|
||||
/*
|
||||
* Window sub-objects. These must also follow the CLEAR/HOLD/DROP
|
||||
* protocol mentioned above.
|
||||
*/
|
||||
JSObject *document;
|
||||
JSObject *history;
|
||||
JSObject *location;
|
||||
JSObject *navigator;
|
||||
JSObject *components;
|
||||
JSObject *screen;
|
||||
JSObject *hardware;
|
||||
JSObject *crypto;
|
||||
JSObject *pkcs11;
|
||||
|
||||
/*
|
||||
* Ad-hoc GC roots.
|
||||
*/
|
||||
JSObject *event_receiver;
|
||||
JSObject *opener;
|
||||
|
||||
JSVersion firstVersion; /* First JS script tag version. */
|
||||
|
||||
/*
|
||||
* Security info for all of this decoder's scripts, except those
|
||||
* contained in layers.
|
||||
*/
|
||||
JSPrincipals *principals;
|
||||
JSPrincipalsList*early_access_list;
|
||||
|
||||
IL_GroupContext *image_context; /* Image context for anonymous images */
|
||||
|
||||
/*
|
||||
* Table that maintains an id to JS object mapping for reflected
|
||||
* elements. This is used during resize to reestablish the connection
|
||||
* between layout elements and their corresponding JS object.
|
||||
* Form elements are special, since they can't use the same keying
|
||||
*/
|
||||
PRHashTable *id_to_object_map;
|
||||
} MochaDecoder;
|
||||
|
||||
/*
|
||||
* Number of buckets for the id-to-object hash table.
|
||||
*/
|
||||
#define LM_ID_TO_OBJ_MAP_SIZE 20
|
||||
#define LM_FORM_ELEMENT_MAP_SIZE 10
|
||||
|
||||
/*
|
||||
* Types of objects reflected into Mocha
|
||||
*/
|
||||
typedef enum {
|
||||
LM_APPLETS = 0,
|
||||
LM_FORMS,
|
||||
LM_LINKS,
|
||||
LM_NAMEDANCHORS,
|
||||
LM_EMBEDS,
|
||||
LM_IMAGES,
|
||||
LM_FORMELEMENTS,
|
||||
LM_LAYERS
|
||||
} ReflectedObject;
|
||||
|
||||
/*
|
||||
* Generates an id-to-object mapping key from the ReflectedObject
|
||||
* type, the containing layer id and the id of the object itself.
|
||||
* The key is 4 bits type, 14 bits layer_id and 14 bits id.
|
||||
*/
|
||||
#define LM_GET_MAPPING_KEY(obj_type, layer_id, id) \
|
||||
(void *)(((((uint32)obj_type) << 28) & 0xF0000000UL) | \
|
||||
((((uint32)layer_id) << 14) & 0x0FFFC000UL) | \
|
||||
(((uint32)id) & 0x00003FFFUL))
|
||||
|
||||
/*
|
||||
* Public, well-known string constants.
|
||||
*/
|
||||
extern char js_language_name[]; /* "JavaScript" */
|
||||
extern char js_content_type[]; /* "application/x-javascript" */
|
||||
|
||||
/*
|
||||
* Initialize and finalize Mocha-in-the-client.
|
||||
*/
|
||||
extern void LM_InitMocha(void);
|
||||
extern void LM_FinishMocha(void);
|
||||
|
||||
/*
|
||||
* Force mocha on in the given context, even if the user pref is set to
|
||||
* disable mocha.
|
||||
*/
|
||||
extern void LM_ForceJSEnabled(MWContext *cx);
|
||||
|
||||
/*
|
||||
* Initialize and finalize Mocha-Java connection
|
||||
*/
|
||||
#define LM_MOJA_UNINITIALIZED 0
|
||||
#define LM_MOJA_OK 1
|
||||
#define LM_MOJA_JAVA_FAILED 2
|
||||
#define LM_MOJA_OUT_OF_MEMORY 3
|
||||
extern int LM_InitMoja(void);
|
||||
extern void LM_FinishMoja(void);
|
||||
extern int LM_IsMojaInitialized(void);
|
||||
|
||||
/*
|
||||
* Enter or leave the big mocha lock. Any thread which wants to
|
||||
* preserve JavaScript run-to-completion semantics must bracket
|
||||
* JavaScript evaluation with these calls.
|
||||
*/
|
||||
typedef void
|
||||
(PR_CALLBACK *JSLockReleaseFunc)(void * data);
|
||||
|
||||
|
||||
extern void PR_CALLBACK LM_LockJS(MWContext *mwc);
|
||||
extern void PR_CALLBACK LM_UnlockJS(MWContext *mwc);
|
||||
extern JSBool PR_CALLBACK LM_AttemptLockJS(MWContext *mwc,
|
||||
JSLockReleaseFunc fn, void * data);
|
||||
extern JSBool PR_CALLBACK LM_ClearAttemptLockJS(MWContext *mwc,
|
||||
JSLockReleaseFunc fn,
|
||||
void * data);
|
||||
extern PRBool PR_CALLBACK
|
||||
LM_HandOffJSLock(PRThread * oldOwner, PRThread *newOwner);
|
||||
|
||||
/*
|
||||
* For interruption purposes we will sometimes need to know the
|
||||
* context who is holding the JS lock
|
||||
*/
|
||||
extern void LM_JSLockSetContext(MWContext * context);
|
||||
extern MWContext * LM_JSLockGetContext(MWContext *mwc);
|
||||
|
||||
/*
|
||||
* Enable/disable for Mocha-in-the-client.
|
||||
*/
|
||||
#define LM_SwitchMocha(toggle) LM_SetMochaEnabled(toggle)
|
||||
|
||||
extern JSBool
|
||||
LM_GetMochaEnabled(void);
|
||||
|
||||
/*
|
||||
* Get (create if necessary) a MochaDecoder for context, adding a reference
|
||||
* to its window_object. Put drops the reference, destroying window_object
|
||||
* when the count reaches zero. These functions should only be called in
|
||||
* the mocha thread or while holding the JS-lock
|
||||
*/
|
||||
extern MochaDecoder *
|
||||
LM_GetMochaDecoder(MWContext *context);
|
||||
|
||||
extern void
|
||||
LM_PutMochaDecoder(MochaDecoder *decoder);
|
||||
|
||||
/*
|
||||
* Get the source URL for script being loaded by document. This URL will be
|
||||
* the document's URL for inline script, or the SRC= URL for included script.
|
||||
* The returned pointer is safe only within the extent of the function that
|
||||
* calls LM_GetSourceURL().
|
||||
*/
|
||||
extern const char *
|
||||
LM_GetSourceURL(MochaDecoder *decoder);
|
||||
|
||||
/*
|
||||
* Set the current layer and hence the current scope for script evaluation.
|
||||
*/
|
||||
extern void
|
||||
LM_SetActiveLayer(MWContext * context, int32 layer_id);
|
||||
|
||||
/*
|
||||
* Get the current layer and hence the current scope for script evaluation.
|
||||
*/
|
||||
extern int32
|
||||
LM_GetActiveLayer(MWContext * context);
|
||||
|
||||
/*
|
||||
* Evaluate the contents of a SCRIPT tag. You can specify the JSObject
|
||||
* to use as the base scope. Pass NULL to use the default window_object
|
||||
*/
|
||||
extern JSBool
|
||||
LM_EvaluateBuffer(MochaDecoder *decoder, void *base, size_t length,
|
||||
uint lineno, char * scope_to, struct JSPrincipals *principals,
|
||||
JSBool unicode, jsval *result);
|
||||
|
||||
/*
|
||||
* Evaluate an expression entity in an HTML attribute (WIDTH="&{height/2};").
|
||||
* Returns null on error, otherwise a pointer to the malloc'd string result.
|
||||
* The caller is responsible for freeing the string result.
|
||||
*/
|
||||
extern char *
|
||||
LM_EvaluateAttribute(MWContext *context, char *expr, uint lineno);
|
||||
|
||||
/*
|
||||
* Remove any MochaDecoder window_context pointer to an MWContext that's
|
||||
* being destroyed.
|
||||
*/
|
||||
extern void
|
||||
LM_RemoveWindowContext(MWContext *context, History_entry * he);
|
||||
|
||||
extern void
|
||||
LM_DropSavedWindow(MWContext *context, void *window);
|
||||
|
||||
/*
|
||||
* Set and clear the HTML stream and URL for the MochaDecoder
|
||||
* associated with the given context
|
||||
*/
|
||||
extern JSBool
|
||||
LM_SetDecoderStream(MWContext * context, NET_StreamClass *stream,
|
||||
URL_Struct *url_struct, JSBool free_stream_on_close);
|
||||
|
||||
/*
|
||||
* Start caching HTML or plain text generated by document.write() where the
|
||||
* script is running on mc, the document is being generated into decoder's
|
||||
* window, and url_struct tells about the generator.
|
||||
*/
|
||||
extern NET_StreamClass *
|
||||
LM_WysiwygCacheConverter(MWContext *context, URL_Struct *url_struct,
|
||||
const char * wysiwyg_url, const char * base_href);
|
||||
|
||||
/*
|
||||
* Skip over the "wysiwyg://docid/" in url_string and return a pointer to the
|
||||
* real URL hidden after the prefix. If url_string is not of "wysiwyg:" type,
|
||||
* just return url_string. Never returns null.
|
||||
*/
|
||||
extern const char *
|
||||
LM_StripWysiwygURLPrefix(const char *url_string);
|
||||
|
||||
/*
|
||||
* This function works only on "wysiwyg:" type URLs -- don't call it unless
|
||||
* you know that NET_URL_Type(url_string) is WYSIWYG_TYPE_URL. It'll return
|
||||
* null if url_string seems too short, or if it can't find the third slash.
|
||||
*/
|
||||
extern const char *
|
||||
LM_SkipWysiwygURLPrefix(const char *url_string);
|
||||
|
||||
/*
|
||||
* Return a pointer to a malloc'd string of the form "<BASE HREF=...>" where
|
||||
* the "..." URL is the directory of cx's origin URL. Such a base URL is the
|
||||
* default base for relative URLs in generated HTML.
|
||||
*/
|
||||
extern char *
|
||||
LM_GetBaseHrefTag(JSContext *cx, JSPrincipals *principals);
|
||||
|
||||
/*
|
||||
* XXX Make these public LO_... typedefs in lo_ele.h/ntypes.h?
|
||||
*/
|
||||
struct lo_FormData_struct;
|
||||
struct lo_NameList_struct;
|
||||
|
||||
extern struct lo_FormData_struct *
|
||||
LO_GetFormDataByID(MWContext *context, int32 layer_id, intn form_id);
|
||||
|
||||
extern uint
|
||||
LO_EnumerateForms(MWContext *context, int32 layer_id);
|
||||
|
||||
extern struct LO_ImageStruct_struct *
|
||||
LO_GetImageByIndex(MWContext *context, int32 layer_id, intn image_id);
|
||||
|
||||
extern uint
|
||||
LO_EnumerateImages(MWContext *context, int32 layer_id);
|
||||
|
||||
/*
|
||||
* Reflect display layers into Mocha.
|
||||
*/
|
||||
extern JSObject *
|
||||
LM_ReflectLayer(MWContext *context, int32 layer_id, int32 parent_layer_id,
|
||||
PA_Tag *tag);
|
||||
|
||||
extern LO_FormElementStruct *
|
||||
LO_GetFormElementByIndex(struct lo_FormData_struct *form_data, int32 index);
|
||||
|
||||
extern uint
|
||||
LO_EnumerateFormElements(MWContext *context,
|
||||
struct lo_FormData_struct *form_data);
|
||||
|
||||
/*
|
||||
* Layout helper function to find a named anchor by its index in the
|
||||
* document.anchors[] array.
|
||||
*/
|
||||
extern struct lo_NameList_struct *
|
||||
LO_GetNamedAnchorByIndex(MWContext *context, int32 layer_id, uint index);
|
||||
|
||||
extern uint
|
||||
LO_EnumerateNamedAnchors(MWContext *context, int32 layer_id);
|
||||
|
||||
/*
|
||||
* Layout Mocha helper function to find an HREF Anchor by its index in the
|
||||
* document.links[] array.
|
||||
*/
|
||||
extern LO_AnchorData *
|
||||
LO_GetLinkByIndex(MWContext *context, int32 layer_id, uint index);
|
||||
|
||||
extern uint
|
||||
LO_EnumerateLinks(MWContext *context, int32 layer_id);
|
||||
|
||||
extern LO_JavaAppStruct *
|
||||
LO_GetAppletByIndex(MWContext *context, int32 layer_id, uint index);
|
||||
|
||||
extern uint
|
||||
LO_EnumerateApplets(MWContext *context, int32 layer_id);
|
||||
|
||||
extern LO_EmbedStruct *
|
||||
LO_GetEmbedByIndex(MWContext *context, int32 layer_id, uint index);
|
||||
|
||||
extern uint
|
||||
LO_EnumerateEmbeds(MWContext *context, int32 layer_id);
|
||||
|
||||
/*
|
||||
* Get and set a color attribute in the current document state.
|
||||
*/
|
||||
extern void
|
||||
LO_GetDocumentColor(MWContext *context, int type, LO_Color *color);
|
||||
|
||||
extern void
|
||||
LO_SetDocumentColor(MWContext *context, int type, LO_Color *color);
|
||||
|
||||
/*
|
||||
* Layout function to reallocate the lo_FormElementOptionData array pointed at
|
||||
* by lo_FormElementSelectData's options member to include space for the number
|
||||
* of options given by selectData->option_cnt.
|
||||
*/
|
||||
extern XP_Bool
|
||||
LO_ResizeSelectOptions(lo_FormElementSelectData *selectData);
|
||||
|
||||
/*
|
||||
* Discard the current document and all its subsidiary objects.
|
||||
*/
|
||||
extern void
|
||||
LM_ReleaseDocument(MWContext *context, JSBool resize_reload);
|
||||
|
||||
/*
|
||||
* Search if a the event is being captured in the frame hierarchy.
|
||||
*/
|
||||
extern XP_Bool
|
||||
LM_EventCaptureCheck(MWContext *context, uint32 current_event);
|
||||
|
||||
/*
|
||||
* Scroll a window to the given point.
|
||||
*/
|
||||
extern void LM_SendOnScroll(MWContext *context, int32 x, int32 y);
|
||||
|
||||
/*
|
||||
* Display a help topic.
|
||||
*/
|
||||
extern void LM_SendOnHelp(MWContext *context);
|
||||
|
||||
/*
|
||||
* Send a load or abort event for an image to a callback.
|
||||
*/
|
||||
typedef enum LM_ImageEvent {
|
||||
LM_IMGUNBLOCK = 0,
|
||||
LM_IMGLOAD = 1,
|
||||
LM_IMGABORT = 2,
|
||||
LM_IMGERROR = 3,
|
||||
LM_LASTEVENT = 3
|
||||
} LM_ImageEvent;
|
||||
|
||||
extern void
|
||||
LM_ProcessImageEvent(MWContext *context, LO_ImageStruct *image_data,
|
||||
LM_ImageEvent event);
|
||||
|
||||
/* This should be called when a named anchor is located. */
|
||||
extern JSBool
|
||||
LM_SendOnLocate(MWContext *context, struct lo_NameList_struct *name_rec);
|
||||
|
||||
extern JSObject *
|
||||
LM_ReflectApplet(MWContext *context, LO_JavaAppStruct *applet_data,
|
||||
PA_Tag * tag, int32 layer_id, uint index);
|
||||
|
||||
extern JSObject *
|
||||
LM_ReflectEmbed(MWContext *context, LO_EmbedStruct *lo_embed,
|
||||
PA_Tag * tag, int32 layer_id, uint index);
|
||||
|
||||
struct lo_FormData_struct;
|
||||
struct lo_NameList_struct;
|
||||
|
||||
extern JSObject *
|
||||
LM_ReflectForm(MWContext *context, struct lo_FormData_struct *form_data,
|
||||
PA_Tag * tag, int32 layer_id, uint index);
|
||||
|
||||
extern JSObject *
|
||||
LM_ReflectFormElement(MWContext *context, int32 layer_id, int32 form_id,
|
||||
int32 element_id, PA_Tag * tag);
|
||||
|
||||
extern JSObject *
|
||||
LM_ReflectLink(MWContext *context, LO_AnchorData *anchor_data, PA_Tag * tag,
|
||||
int32 layer_id, uint index);
|
||||
|
||||
extern JSObject *
|
||||
LM_ReflectNamedAnchor(MWContext *context, struct lo_NameList_struct *name_rec,
|
||||
PA_Tag * tag, int32 layer_id, uint index);
|
||||
|
||||
extern JSObject *
|
||||
LM_ReflectImage(MWContext *context, LO_ImageStruct *image_data,
|
||||
PA_Tag * tag, int32 layer_id, uint index);
|
||||
|
||||
extern JSBool
|
||||
LM_CanDoJS(MWContext *context);
|
||||
|
||||
extern JSBool
|
||||
LM_IsActive(MWContext *context);
|
||||
|
||||
/*
|
||||
* Security.
|
||||
*/
|
||||
|
||||
extern JSPrincipals *
|
||||
LM_NewJSPrincipals(URL_Struct *archive, char *name, const char *codebase);
|
||||
|
||||
extern char *
|
||||
LM_ExtractFromPrincipalsArchive(JSPrincipals *principals, char *name,
|
||||
uint *length);
|
||||
|
||||
extern JSBool
|
||||
LM_SetUntransformedSource(JSPrincipals *principals, char *original,
|
||||
char *transformed);
|
||||
|
||||
extern JSPrincipals * PR_CALLBACK
|
||||
LM_GetJSPrincipalsFromJavaCaller(JSContext *cx, int callerDepth);
|
||||
|
||||
/*
|
||||
* LM_RegisterPrincipals will verify and register a set of principals
|
||||
* in the decoder, modifying decoder->principals in the process. It
|
||||
* returns the modified decoder.
|
||||
*
|
||||
* The "name" parameter may be NULL if "principals" was created with a name.
|
||||
*/
|
||||
|
||||
extern JSPrincipals *
|
||||
LM_RegisterPrincipals(MochaDecoder *decoder, JSPrincipals *principals,
|
||||
char *name, char *src);
|
||||
/*
|
||||
* JavaScript Debugger support
|
||||
*/
|
||||
#ifdef JSDEBUGGER
|
||||
|
||||
extern NET_StreamClass*
|
||||
LM_StreamBuilder( int format_out,
|
||||
void *data_obj,
|
||||
URL_Struct *URL_s,
|
||||
MWContext *mwcontext );
|
||||
|
||||
extern JSBool
|
||||
LM_GetJSDebugActive(void);
|
||||
|
||||
extern void
|
||||
LM_JamSourceIntoJSDebug( const char *filename,
|
||||
const char *str,
|
||||
int32 len,
|
||||
MWContext *mwcontext );
|
||||
|
||||
#endif
|
||||
|
||||
NSPR_END_EXTERN_C
|
||||
|
||||
#endif /* libmocha_h___ */
|
||||
3586
mozilla/lib/layout/layutil.c
Normal file
3586
mozilla/lib/layout/layutil.c
Normal file
File diff suppressed because it is too large
Load Diff
95
mozilla/lib/libmocha/Makefile
Normal file
95
mozilla/lib/libmocha/Makefile
Normal file
@@ -0,0 +1,95 @@
|
||||
#!gmake
|
||||
#
|
||||
# The contents of this file are subject to the Netscape Public License
|
||||
# Version 1.0 (the "NPL"); you may not use this file except in
|
||||
# compliance with the NPL. You may obtain a copy of the NPL at
|
||||
# http://www.mozilla.org/NPL/
|
||||
#
|
||||
# Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
# for the specific language governing rights and limitations under the
|
||||
# NPL.
|
||||
#
|
||||
# The Initial Developer of this code under the NPL is Netscape
|
||||
# Communications Corporation. Portions created by Netscape are
|
||||
# Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
# Reserved.
|
||||
|
||||
|
||||
|
||||
DEPTH = ../..
|
||||
|
||||
MODULE = mocha
|
||||
LIBRARY_NAME = mocha
|
||||
|
||||
REQUIRES = lay net parse img js style layer applet dbm nspr security \
|
||||
htmldlgs util jtools pref java libreg softupdt jsdebug
|
||||
|
||||
CSRCS = et_mocha.c \
|
||||
et_moz.c \
|
||||
lm_applt.c \
|
||||
lm_bars.c \
|
||||
lm_cmpnt.c \
|
||||
lm_doc.c \
|
||||
lm_embed.c \
|
||||
lm_event.c \
|
||||
lm_form.c \
|
||||
lm_hardw.c \
|
||||
lm_hist.c \
|
||||
lm_href.c \
|
||||
lm_img.c \
|
||||
lm_init.c \
|
||||
lm_input.c \
|
||||
lm_nav.c \
|
||||
lm_plgin.c \
|
||||
lm_screen.c \
|
||||
lm_supdt.c \
|
||||
lm_taint.c \
|
||||
lm_trggr.c \
|
||||
lm_url.c \
|
||||
lm_win.c \
|
||||
lm_layer.c \
|
||||
lm_wngrp.c \
|
||||
$(NULL)
|
||||
|
||||
|
||||
ifdef MOZ_JAVA
|
||||
CSRCS += \
|
||||
lm_jsd.c \
|
||||
$(NULL)
|
||||
endif
|
||||
|
||||
ifndef NO_SECURITY
|
||||
CSRCS += lm_crypt.c lm_pk11.c
|
||||
endif
|
||||
|
||||
include $(DEPTH)/config/rules.mk
|
||||
|
||||
DEFINES += -DDLL_SUFFIX=\"$(DLL_SUFFIX)\"
|
||||
|
||||
ifdef JS_THREADSAFE
|
||||
DEFINES += -DJS_THREADSAFE
|
||||
endif
|
||||
|
||||
EMBED_CFLAGS = $(CFLAGS) -I$(DEPTH)/lib/plugin
|
||||
TAINT_CFLAGS = $(CFLAGS) -I$(DEPTH)/lib/libjar -I$(DEPTH)/sun-java/netscape/security/_jri
|
||||
|
||||
ifneq ($(OS_ARCH),OS2)
|
||||
$(OBJDIR)/lm_embed.o: lm_embed.c
|
||||
@$(MAKE_OBJDIR)
|
||||
$(CC) -o $@ -c $(EMBED_CFLAGS) $<
|
||||
|
||||
$(OBJDIR)/lm_taint.o: lm_taint.c
|
||||
@$(MAKE_OBJDIR)
|
||||
$(CC) -o $@ -c $(TAINT_CFLAGS) $<
|
||||
|
||||
else
|
||||
$(OBJDIR)/lm_embed.o: lm_embed.c
|
||||
@$(MAKE_OBJDIR)
|
||||
$(CC) -Fo$@ -c $(EMBED_CFLAGS) $<
|
||||
|
||||
$(OBJDIR)/lm_taint.o: lm_taint.c
|
||||
@$(MAKE_OBJDIR)
|
||||
$(CC) -Fo$@ -c $(TAINT_CFLAGS) $<
|
||||
|
||||
endif
|
||||
2650
mozilla/lib/libmocha/et_mocha.c
Normal file
2650
mozilla/lib/libmocha/et_mocha.c
Normal file
File diff suppressed because it is too large
Load Diff
2941
mozilla/lib/libmocha/et_moz.c
Normal file
2941
mozilla/lib/libmocha/et_moz.c
Normal file
File diff suppressed because it is too large
Load Diff
880
mozilla/lib/libmocha/lm.h
Normal file
880
mozilla/lib/libmocha/lm.h
Normal file
@@ -0,0 +1,880 @@
|
||||
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
|
||||
#ifndef lm_h___
|
||||
#define lm_h___
|
||||
/*
|
||||
* JS in the Navigator library-private interface.
|
||||
*/
|
||||
#include "xp.h" /* for uint and PA_Block */
|
||||
#include "prlong.h" /* for int64 time type used below */
|
||||
#include "libevent.h" /* until its a stand-alone */
|
||||
#include "libmocha.h"
|
||||
|
||||
/*
|
||||
* Shared string constants for common property names.
|
||||
*/
|
||||
extern char lm_argc_err_str[]; /* "incorrect number of arguments" */
|
||||
|
||||
extern char lm_unknown_origin_str[]; /* "[unknown origin]" */
|
||||
|
||||
extern char lm_onLoad_str[]; /* "onLoad" */
|
||||
extern char lm_onUnload_str[]; /* "onUnload" */
|
||||
extern char lm_onAbort_str[]; /* "onAbort" */
|
||||
extern char lm_onError_str[]; /* "onError" */
|
||||
extern char lm_onScroll_str[]; /* "onScroll" */
|
||||
extern char lm_onFocus_str[]; /* "onFocus" */
|
||||
extern char lm_onBlur_str[]; /* "onBlur" */
|
||||
extern char lm_onSelect_str[]; /* "onSelect" */
|
||||
extern char lm_onChange_str[]; /* "onChange" */
|
||||
extern char lm_onReset_str[]; /* "onReset" */
|
||||
extern char lm_onSubmit_str[]; /* "onSubmit" */
|
||||
extern char lm_onClick_str[]; /* "onClick" */
|
||||
extern char lm_onMouseDown_str[]; /* "onMouseDown" */
|
||||
extern char lm_onMouseOver_str[]; /* "onMouseOver" */
|
||||
extern char lm_onMouseOut_str[]; /* "onMouseOut" */
|
||||
extern char lm_onMouseUp_str[]; /* "onMouseUp" */
|
||||
extern char lm_onLocate_str[]; /* "onLocate" */
|
||||
extern char lm_onHelp_str[]; /* "onHelp" [EA] */
|
||||
|
||||
extern char lm_focus_str[]; /* "focus" */
|
||||
extern char lm_blur_str[]; /* "blur" */
|
||||
extern char lm_select_str[]; /* "select" */
|
||||
extern char lm_click_str[]; /* "click" */
|
||||
extern char lm_scroll_str[]; /* "scroll" */
|
||||
extern char lm_enable_str[]; /* "enable" */
|
||||
extern char lm_disable_str[]; /* "disable" */
|
||||
|
||||
extern char lm_toString_str[]; /* "toString" */
|
||||
extern char lm_length_str[]; /* "length" */
|
||||
extern char lm_document_str[]; /* "document" */
|
||||
extern char lm_forms_str[]; /* "forms" */
|
||||
extern char lm_links_str[]; /* "links" */
|
||||
extern char lm_anchors_str[]; /* "anchors" */
|
||||
extern char lm_applets_str[]; /* "applets" */
|
||||
extern char lm_embeds_str[]; /* "embeds" */
|
||||
extern char lm_plugins_str[]; /* "plugins" */
|
||||
extern char lm_images_str[]; /* "images" */
|
||||
extern char lm_layers_str[]; /* "layers" */
|
||||
extern char lm_location_str[]; /* "location" */
|
||||
extern char lm_navigator_str[]; /* "navigator" */
|
||||
extern char lm_netcaster_str[]; /* "netcaster" */
|
||||
extern char lm_components_str[]; /* "components" */
|
||||
|
||||
extern char lm_parentLayer_str[]; /* "parentLayer" */
|
||||
extern char lm_opener_str[]; /* "opener" */
|
||||
extern char lm_closed_str[]; /* "closed" */
|
||||
extern char lm_assign_str[]; /* "assign" */
|
||||
extern char lm_reload_str[]; /* "reload" */
|
||||
extern char lm_replace_str[]; /* "replace" */
|
||||
extern char lm_event_str[]; /* "event" */
|
||||
extern char lm_methodPrefix_str[]; /* "#method" */
|
||||
extern char lm_methodArgc_str[]; /* "#method" */
|
||||
extern char lm_methodArgv_str[]; /* "#method" */
|
||||
extern char lm_getPrefix_str[]; /* "#get_" */
|
||||
extern char lm_setPrefix_str[]; /* "#set_" */
|
||||
extern char lm_typePrefix_str[]; /* "#type_" */
|
||||
extern const char *lm_event_argv[]; /* {lm_event_str} */
|
||||
|
||||
extern PRThread *lm_InterpretThread;
|
||||
extern PRThread *mozilla_thread;
|
||||
extern PRThread *lm_js_lock_previous_owner;
|
||||
|
||||
extern JSContext *lm_writing_context;
|
||||
|
||||
/*
|
||||
* Timeout structure threaded on MochaDecoder.timeouts for cleanup.
|
||||
*/
|
||||
struct JSTimeout {
|
||||
int32 ref_count; /* reference count to shared usage */
|
||||
char *expr; /* the JS expression to evaluate */
|
||||
JSObject *funobj; /* or function to call, if !expr */
|
||||
jsval *argv; /* function actual arguments */
|
||||
void *toid; /* Identifier, used internally only */
|
||||
uint32 public_id; /* Returned as value of setTimeout() */
|
||||
uint16 argc; /* and argument count */
|
||||
uint16 spare; /* alignment padding */
|
||||
int32 doc_id; /* document this is for */
|
||||
int32 interval; /* Non-zero if repetitive timeout */
|
||||
int64 when; /* nominal time to run this timeout */
|
||||
JSVersion version; /* Version of JavaScript to execute */
|
||||
JSPrincipals *principals; /* principals with which to execute */
|
||||
char *filename; /* filename of setTimeout call */
|
||||
uint32 lineno; /* line number of setTimeout call */
|
||||
JSTimeout *next; /* next timeout in list */
|
||||
};
|
||||
|
||||
extern void lm_ClearWindowTimeouts(MochaDecoder *decoder);
|
||||
|
||||
struct JSNestingUrl {
|
||||
JSNestingUrl *next;
|
||||
char *str;
|
||||
};
|
||||
|
||||
/*
|
||||
* Event queue stack madness to handle doc.write("<script>doc.write...").
|
||||
*/
|
||||
typedef struct QueueStackElement {
|
||||
PREventQueue * queue;
|
||||
MWContext * context;
|
||||
int32 doc_id;
|
||||
struct QueueStackElement * up;
|
||||
struct QueueStackElement * down;
|
||||
PRPackedBool done;
|
||||
PRPackedBool discarding;
|
||||
PRPackedBool inherit_parent;
|
||||
void * retval;
|
||||
} QueueStackElement;
|
||||
|
||||
extern void
|
||||
et_SubEventLoop(QueueStackElement * qse);
|
||||
|
||||
/*
|
||||
* Stack size per window context, plus one for the navigator.
|
||||
*/
|
||||
#define LM_STACK_SIZE 8192
|
||||
|
||||
extern JSRuntime *lm_runtime;
|
||||
extern JSClass lm_window_class;
|
||||
extern JSClass lm_layer_class;
|
||||
extern JSClass lm_document_class;
|
||||
extern JSClass lm_event_class;
|
||||
|
||||
extern JSBool lm_SaveParamString(JSContext *cx, PA_Block *bp,
|
||||
const char *str);
|
||||
extern MochaDecoder *lm_NewWindow(MWContext *context);
|
||||
extern void lm_DestroyWindow(MochaDecoder *decoder);
|
||||
|
||||
/*
|
||||
* Hold and drop the reference count for tree back-edges that go from object
|
||||
* private data to the containing decoder. These refs do not keep the object
|
||||
* tree under decoder alive from the GC, but they do keep decoder from being
|
||||
* destroyed and some out of order finalizer tripping over its freed memory.
|
||||
*/
|
||||
#ifdef DEBUG
|
||||
extern MochaDecoder *lm_HoldBackCount(MochaDecoder *decoder);
|
||||
extern void lm_DropBackCount(MochaDecoder *decoder);
|
||||
|
||||
#define HOLD_BACK_COUNT(decoder) lm_HoldBackCount(decoder)
|
||||
#define DROP_BACK_COUNT(decoder) lm_DropBackCount(decoder)
|
||||
#else
|
||||
#define HOLD_BACK_COUNT(decoder) \
|
||||
(((decoder) ? (decoder)->back_count++ : 0), (decoder))
|
||||
#define DROP_BACK_COUNT(decoder) \
|
||||
(((decoder) && --(decoder)->back_count <= 0 && !(decoder)->forw_count) \
|
||||
? lm_DestroyWindow(decoder) \
|
||||
: (void)0)
|
||||
#endif
|
||||
|
||||
extern JSBool lm_InitWindowContent(MochaDecoder *decoder);
|
||||
extern JSBool lm_DefineWindowProps(JSContext *cx,
|
||||
MochaDecoder *decoder);
|
||||
extern JSBool lm_ResolveWindowProps(JSContext *cx,
|
||||
MochaDecoder *decoder,
|
||||
JSObject *obj,
|
||||
jsval id);
|
||||
extern void lm_FreeWindowContent(MochaDecoder *decoder,
|
||||
JSBool fromDiscard);
|
||||
extern JSBool lm_SetInputStream(JSContext *cx,
|
||||
MochaDecoder *decoder,
|
||||
NET_StreamClass *stream,
|
||||
URL_Struct *url_struct,
|
||||
JSBool free_stream_on_close);
|
||||
extern JSObject *lm_DefineDocument(MochaDecoder *decoder,
|
||||
int32 layer_id);
|
||||
extern JSObject *lm_DefineHistory(MochaDecoder *decoder);
|
||||
extern JSObject *lm_DefineLocation(MochaDecoder *decoder);
|
||||
extern JSObject *lm_DefineNavigator(MochaDecoder *decoder);
|
||||
extern JSObject *lm_DefineComponents(MochaDecoder *decoder);
|
||||
extern JSObject *lm_DefineCrypto(MochaDecoder *decoder);
|
||||
extern JSObject *lm_DefineScreen(MochaDecoder *decoder,
|
||||
JSObject *parent);
|
||||
extern JSObject *lm_DefineHardware(MochaDecoder *decoder,
|
||||
JSObject *parent);
|
||||
extern JSBool lm_DefinePluginClasses(MochaDecoder *decoder);
|
||||
extern JSBool lm_DefineBarClasses(MochaDecoder *decoder);
|
||||
extern JSBool lm_ResolveBar(JSContext *cx, MochaDecoder *decoder,
|
||||
const char *name);
|
||||
extern JSBool lm_DefineTriggers(void);
|
||||
extern JSObject *lm_NewPluginList(JSContext *cx, JSObject *parent_obj);
|
||||
extern JSObject *lm_NewMIMETypeList(JSContext *cx);
|
||||
extern JSObject *lm_GetDocumentFromLayerId(MochaDecoder *decoder,
|
||||
int32 layer_id);
|
||||
extern JSObject *lm_DefinePkcs11(MochaDecoder *decoder);
|
||||
/*
|
||||
* Get (create if needed) document's form, link, and named anchor arrays.
|
||||
*/
|
||||
extern JSObject *lm_GetFormArray(MochaDecoder *decoder,
|
||||
JSObject *document);
|
||||
extern JSObject *lm_GetLinkArray(MochaDecoder *decoder,
|
||||
JSObject *document);
|
||||
extern JSObject *lm_GetNameArray(MochaDecoder *decoder,
|
||||
JSObject *document);
|
||||
extern JSObject *lm_GetAppletArray(MochaDecoder *decoder,
|
||||
JSObject *document);
|
||||
extern JSObject *lm_GetEmbedArray(MochaDecoder *decoder,
|
||||
JSObject *document);
|
||||
extern JSObject *lm_GetImageArray(MochaDecoder *decoder,
|
||||
JSObject *document);
|
||||
extern JSObject *lm_GetDocumentLayerArray(MochaDecoder *decoder,
|
||||
JSObject *document);
|
||||
|
||||
|
||||
/*
|
||||
* dummy object for applets and embeds that can't be reflected
|
||||
*/
|
||||
extern JSObject *lm_DummyObject;
|
||||
extern void lm_InitDummyObject(JSContext *cx);
|
||||
|
||||
/* bit vector for handlers */
|
||||
typedef enum {
|
||||
HANDLER_ONCLICK = 1 << 0,
|
||||
HANDLER_ONFOCUS = 1 << 1,
|
||||
HANDLER_ONBLUR = 1 << 2,
|
||||
HANDLER_ONCHANGE = 1 << 3,
|
||||
HANDLER_ONSELECT = 1 << 4,
|
||||
HANDLER_ONSCROLL = 1 << 5,
|
||||
HANDLER_ONMOUSEDOWN = 1 << 6,
|
||||
HANDLER_ONMOUSEUP = 1 << 7,
|
||||
HANDLER_ONKEYDOWN = 1 << 8,
|
||||
HANDLER_ONKEYUP = 1 << 9,
|
||||
HANDLER_ONKEYPRESS = 1 << 10,
|
||||
HANDLER_ONDBLCLICK = 1 << 11
|
||||
} JSHandlersBitVector;
|
||||
|
||||
/*
|
||||
* Base class of all JS input private object data structures.
|
||||
*/
|
||||
typedef struct JSInputBase {
|
||||
MochaDecoder *decoder; /* this window's JS decoder */
|
||||
int32 type; /* layout form element type */
|
||||
JSHandlersBitVector handlers; /* bit vector for handlers */
|
||||
} JSInputBase;
|
||||
|
||||
/*
|
||||
* Base class of event-handling elements like layers and documents.
|
||||
*/
|
||||
typedef struct JSInputHandler {
|
||||
JSInputBase base; /* decoder and type */
|
||||
JSObject *object; /* this input handler's JS object */
|
||||
uint32 event_mask; /* mask of events in progress */
|
||||
} JSInputHandler;
|
||||
|
||||
/*
|
||||
* Base class of input event-capturing elements like layers and documents.
|
||||
*/
|
||||
typedef struct JSEventReceiver {
|
||||
JSObject *object; /* this event receiver's JS object */
|
||||
uint32 event_mask; /* mask of events in progress */
|
||||
} JSEventReceiver;
|
||||
|
||||
/*
|
||||
* Base class of input event-handling elements like anchors and form inputs.
|
||||
*/
|
||||
typedef struct JSEventCapturer {
|
||||
JSEventReceiver base; /* this event capturer's receiver base */
|
||||
uint32 event_bit; /* mask of events being captured */
|
||||
} JSEventCapturer;
|
||||
|
||||
#define base_decoder base.decoder
|
||||
#define base_type base.type
|
||||
#define base_handlers base.handlers
|
||||
|
||||
/*
|
||||
* JS URL object.
|
||||
*
|
||||
* Location is a special URL: when you set one of its properties, your client
|
||||
* window goes to the newly formed address.
|
||||
*/
|
||||
typedef struct JSURL {
|
||||
JSInputHandler handler;
|
||||
int32 layer_id;
|
||||
uint32 index;
|
||||
JSString *href;
|
||||
JSString *target;
|
||||
JSString *text;
|
||||
} JSURL;
|
||||
|
||||
/* JS Document Object
|
||||
* Documents exist per-window and per-layer
|
||||
*/
|
||||
typedef struct JSDocument {
|
||||
JSEventCapturer capturer;
|
||||
MochaDecoder *decoder;
|
||||
JSObject *object;
|
||||
int32 layer_id; /* The containing layer's id */
|
||||
JSObject *forms;
|
||||
JSObject *links;
|
||||
JSObject *anchors;
|
||||
JSObject *applets;
|
||||
JSObject *embeds;
|
||||
JSObject *images;
|
||||
JSObject *layers;
|
||||
} JSDocument;
|
||||
|
||||
#define URL_NOT_INDEXED ((uint32)-1)
|
||||
|
||||
#define url_decoder handler.base_decoder
|
||||
#define url_type handler.base_type
|
||||
#define url_object handler.object
|
||||
#define url_event_mask handler.event_mask
|
||||
|
||||
extern JSURL *
|
||||
lm_NewURL(JSContext *cx, MochaDecoder *decoder,
|
||||
LO_AnchorData *anchor_data, JSObject *document);
|
||||
|
||||
extern void
|
||||
lm_ReplaceURL(MWContext *context, URL_Struct *url_struct);
|
||||
|
||||
extern JSBool
|
||||
lm_GetURL(JSContext *cx, MochaDecoder *decoder, URL_Struct *url_struct);
|
||||
|
||||
extern const char *
|
||||
lm_CheckURL(JSContext *cx, const char *url_string, JSBool checkFile);
|
||||
|
||||
extern JSBool
|
||||
lm_CheckWindowName(JSContext *cx, const char *window_name);
|
||||
|
||||
extern PRHashTable *
|
||||
lm_GetIdToObjectMap(MochaDecoder *decoder);
|
||||
|
||||
extern JSBool PR_CALLBACK
|
||||
lm_BranchCallback(JSContext *cx, JSScript *script);
|
||||
|
||||
extern void PR_CALLBACK
|
||||
lm_ErrorReporter(JSContext *cx, const char *message,
|
||||
JSErrorReport *report);
|
||||
|
||||
extern JSObject *
|
||||
lm_GetFormObjectByID(MWContext *context, int32 layer_id, uint form_id);
|
||||
|
||||
extern LO_FormElementStruct *
|
||||
lm_GetFormElementByIndex(JSContext * cx, JSObject *form_obj, int32 index);
|
||||
|
||||
extern JSObject *
|
||||
lm_GetFormElementFromMapping(JSContext *cx, JSObject *form_obj, uint32 index);
|
||||
|
||||
extern JSBool
|
||||
lm_AddFormElement(JSContext *cx, JSObject *form, JSObject *obj,
|
||||
char *name, uint index);
|
||||
|
||||
extern JSBool
|
||||
lm_ReflectRadioButtonArray(MWContext *context, int32 layer_id, intn form_id,
|
||||
const char *name, PA_Tag * tag);
|
||||
|
||||
extern JSBool
|
||||
lm_SendEvent(MWContext *context, JSObject *obj, JSEvent *event,
|
||||
jsval *result);
|
||||
|
||||
extern JSBool
|
||||
lm_HandleEvent(JSContext *cx, JSObject *obj, JSObject *eventObj,
|
||||
jsval funval, jsval *result);
|
||||
|
||||
extern JSBool
|
||||
lm_FindEventHandler(MWContext *context, JSObject *obj, JSObject *eventObj,
|
||||
jsval funval, jsval *result);
|
||||
|
||||
extern JSObject *
|
||||
lm_NewEventObject(MochaDecoder * decoder, JSEvent * pEvent);
|
||||
|
||||
typedef struct JSEventNames {
|
||||
const char *lowerName;
|
||||
const char *mixedName;
|
||||
} JSEventNames;
|
||||
|
||||
extern const char *
|
||||
lm_EventName(uint32 event_bit);
|
||||
|
||||
extern JSEventNames *
|
||||
lm_GetEventNames(uint32 event_bit);
|
||||
|
||||
/*
|
||||
* Compile the given attribute and attach it to the JSObject
|
||||
*/
|
||||
extern JSBool
|
||||
lm_CompileEventHandler(MochaDecoder * decoder, PA_Block id, PA_Block data,
|
||||
int newline_(cx, sizeof *option);
|
||||
if (!option)
|
||||
goto bad;
|
||||
|
||||
option_obj =
|
||||
JS_NewObject(cx, &lm_option_class,
|
||||
input->input_decoder->option_prototype, obj);
|
||||
|
||||
if (!option_obj || !JS_SetPrivate(cx, option_obj, option)) {
|
||||
JS_free(cx, option);
|
||||
goto bad;
|
||||
}
|
||||
option->decoder = HOLD_BACK_COUNT(input->input_decoder);
|
||||
option->object = option_obj;
|
||||
option->index = (uint32)slot;
|
||||
option->indexInForm = form_element->element_index;
|
||||
option->data = NULL;
|
||||
*vp = OBJECT_TO_JSVAL(option_obj);
|
||||
goto good;
|
||||
}
|
||||
}
|
||||
break;
|
||||
|
||||
case FORM_TYPE_RADIO:
|
||||
case FORM_TYPE_CHECKBOX:
|
||||
{
|
||||
lo_FormElementToggleData *toggle;
|
||||
|
||||
toggle = &form_element->element_data->ele_toggle;
|
||||
switch (input_slot) {
|
||||
case INPUT_NAME:
|
||||
str = lm_LocalEncodingToStr(context,
|
||||
(char *)toggle->name);
|
||||
break;
|
||||
case INPUT_VALUE:
|
||||
str = lm_LocalEncodingToStr(context,
|
||||
(char *)toggle->value);
|
||||
break;
|
||||
case INPUT_STATUS:
|
||||
*vp = BOOLEAN_TO_JSVAL(toggle->toggled);
|
||||
goto good;
|
||||
case INPUT_DEFAULT_STATUS:
|
||||
*vp = BOOLEAN_TO_JSVAL(toggle->default_toggle);
|
||||
goto good;
|
||||
|
||||
#if DISABLED_READONLY_SUPPORT
|
||||
case INPUT_DISABLED:
|
||||
*vp = BOOLEAN_TO_JSVAL(toggle->disabled);
|
||||
goto good;
|
||||
case INPUT_READONLY:
|
||||
*vp = BOOLEAN_TO_JSVAL(FALSE);
|
||||
goto good;
|
||||
#endif
|
||||
default:
|
||||
/* Don't mess with a user-defined property. */
|
||||
goto good;
|
||||
}
|
||||
}
|
||||
break;
|
||||
|
||||
default:
|
||||
{
|
||||
lo_FormElementMinimalData *minimal;
|
||||
|
||||
minimal = &form_element->element_data->ele_minimal;
|
||||
switch (input_slot) {
|
||||
case INPUT_NAME:
|
||||
str = lm_LocalEncodingToStr(context,
|
||||
(char *)minimal->name);
|
||||
break;
|
||||
case INPUT_VALUE:
|
||||
str = lm_LocalEncodingToStr(context,
|
||||
(char *)minimal->value);
|
||||
break;
|
||||
#if DISABLED_READONLY_SUPPORT
|
||||
case INPUT_DISABLED:
|
||||
*vp = BOOLEAN_TO_JSVAL(minimal->disabled);
|
||||
goto good;
|
||||
case INPUT_READONLY:
|
||||
*vp = BOOLEAN_TO_JSVAL(FALSE); /* minimal elements don't have the readonly attribute. */
|
||||
goto good;
|
||||
#endif
|
||||
default:
|
||||
/* Don't mess with a user-defined property. */
|
||||
goto good;
|
||||
}
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
if (!str)
|
||||
goto bad;
|
||||
*vp = STRING_TO_JSVAL(str);
|
||||
|
||||
good:
|
||||
LO_UnlockLayout();
|
||||
return JS_TRUE;
|
||||
|
||||
bad:
|
||||
LO_UnlockLayout();
|
||||
return JS_FALSE;
|
||||
|
||||
}
|
||||
|
||||
char *
|
||||
lm_FixNewlines(JSContext *cx, const char *value, JSBool formElement)
|
||||
{
|
||||
size_t size;
|
||||
const char *cp;
|
||||
char *tp, *new_value;
|
||||
|
||||
#if defined XP_PC
|
||||
size = 1;
|
||||
for (cp = value; *cp != '\0'; cp++) {
|
||||
switch (*cp) {
|
||||
case '\r':
|
||||
if (cp[1] != '\n')
|
||||
size++;
|
||||
break;
|
||||
case '\n':
|
||||
if (cp > value && cp[-1] != '\r')
|
||||
size++;
|
||||
break;
|
||||
}
|
||||
}
|
||||
size += cp - value;
|
||||
#else
|
||||
size = XP_STRLEN(value) + 1;
|
||||
#endif
|
||||
new_value = JS_malloc(cx, size);
|
||||
if (!new_value)
|
||||
return NULL;
|
||||
for (cp = value, tp = new_value; *cp != '\0'; cp++) {
|
||||
#if defined XP_MAC
|
||||
if (*cp == '\n') {
|
||||
if (cp > value && cp[-1] != '\r')
|
||||
*tp++ = '\r';
|
||||
} else {
|
||||
*tp++ = *cp;
|
||||
}
|
||||
#elif defined XP_PC
|
||||
switch (*cp) {
|
||||
case '\r':
|
||||
*tp++ = '\r';
|
||||
if (cp[1] != '\n' && formElement)
|
||||
*tp++ = '\n';
|
||||
break;
|
||||
case '\n':
|
||||
if (cp > value && cp[-1] != '\r' && formElement)
|
||||
*tp++ = '\r';
|
||||
*tp++ = '\n';
|
||||
break;
|
||||
default:
|
||||
*tp++ = *cp;
|
||||
break;
|
||||
}
|
||||
#else /* XP_UNIX */
|
||||
if (*cp == '\r') {
|
||||
if (cp[1] != '\n')
|
||||
*tp++ = '\n';
|
||||
} else {
|
||||
*tp++ = *cp;
|
||||
}
|
||||
#endif
|
||||
}
|
||||
*tp = '\0';
|
||||
return new_value;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
input_setProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
|
||||
{
|
||||
JSInput *input;
|
||||
enum input_slot input_slot;
|
||||
const char *prop_name;
|
||||
char *value = NULL;
|
||||
LO_FormElementStruct *form_element;
|
||||
MochaDecoder *decoder;
|
||||
MWContext *context;
|
||||
int32 intval;
|
||||
jsint slot;
|
||||
|
||||
input = JS_GetInstancePrivate(cx, obj, &lm_input_class, NULL);
|
||||
if (!input)
|
||||
return JS_TRUE;
|
||||
|
||||
/* If the property is seting a key handler we find out now so
|
||||
* that we can tell the front end to send the event. */
|
||||
if (JSVAL_IS_STRING(id)) {
|
||||
prop_name = JS_GetStringBytes(JSVAL_TO_STRING(id));
|
||||
/* XXX use lm_onKeyDown_str etc. initialized by PARAM_ONKEYDOWN */
|
||||
if (XP_STRCASECMP(prop_name, "onkeydown") == 0 ||
|
||||
XP_STRCASECMP(prop_name, "onkeyup") == 0 ||
|
||||
XP_STRCASECMP(prop_name, "onkeypress") == 0) {
|
||||
form_element = lm_GetFormElementByIndex(cx, JS_GetParent(cx, obj),
|
||||
input->index);
|
||||
form_element->event_handler_present = TRUE;
|
||||
}
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
XP_ASSERT(JSVAL_IS_INT(id));
|
||||
slot = JSVAL_TO_INT(id);
|
||||
|
||||
decoder = input->input_decoder;
|
||||
context = decoder->window_context;
|
||||
input_slot = slot;
|
||||
switch (input_slot) {
|
||||
case INPUT_TYPE:
|
||||
case INPUT_FORM:
|
||||
case INPUT_OPTIONS:
|
||||
/* These are immutable. */
|
||||
break;
|
||||
case INPUT_NAME:
|
||||
case INPUT_VALUE:
|
||||
case INPUT_DEFAULT_VALUE:
|
||||
/* These are string-valued. */
|
||||
if (!JSVAL_IS_STRING(*vp) &&
|
||||
!JS_ConvertValue(cx, *vp, JSTYPE_STRING, vp)) {
|
||||
return JS_FALSE;
|
||||
}
|
||||
value = lm_StrToLocalEncoding(context, JSVAL_TO_STRING(*vp));
|
||||
break;
|
||||
case INPUT_STATUS:
|
||||
case INPUT_DEFAULT_STATUS:
|
||||
#if DISABLED_READONLY_SUPPORT
|
||||
case INPUT_READONLY:
|
||||
case INPUT_DISABLED:
|
||||
#endif
|
||||
/* These must be Booleans. */
|
||||
if (!JSVAL_IS_BOOLEAN(*vp) &&
|
||||
!JS_ConvertValue(cx, *vp, JSTYPE_BOOLEAN, vp)) {
|
||||
return JS_FALSE;
|
||||
}
|
||||
break;
|
||||
case INPUT_LENGTH:
|
||||
case INPUT_SELECTED_INDEX:
|
||||
/* These should be integers. */
|
||||
if (JSVAL_IS_INT(*vp))
|
||||
intval = JSVAL_TO_INT(*vp);
|
||||
else if (!JS_ValueToInt32(cx, *vp, &intval)) {
|
||||
return JS_FALSE;
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
LO_LockLayout();
|
||||
|
||||
form_element = lm_GetFormElementByIndex(cx, JS_GetParent(cx, obj),
|
||||
input->index);
|
||||
if (!form_element)
|
||||
goto good;
|
||||
|
||||
switch (form_element->element_data->type) {
|
||||
case FORM_TYPE_FILE:
|
||||
/* if we try to set a file upload widget we better be a signed script */
|
||||
if (!lm_CanAccessTarget(cx, JSTARGET_UNIVERSAL_FILE_READ))
|
||||
break;
|
||||
/* else fall through... */
|
||||
|
||||
case FORM_TYPE_TEXT:
|
||||
case FORM_TYPE_TEXTAREA: /* XXX we ASSUME common struct prefixes */
|
||||
case FORM_TYPE_PASSWORD:
|
||||
{
|
||||
lo_FormElementTextData *text;
|
||||
JSBool ok;
|
||||
char * fixed_string;
|
||||
|
||||
text = &form_element->element_data->ele_text;
|
||||
switch (input_slot) {
|
||||
case INPUT_NAME:
|
||||
if (!lm_SaveParamString(cx, &text->name, value))
|
||||
goto bad;
|
||||
break;
|
||||
case INPUT_VALUE:
|
||||
case INPUT_DEFAULT_VALUE:
|
||||
fixed_string = lm_FixNewlines(cx, value, JS_TRUE);
|
||||
if (!fixed_string)
|
||||
goto bad;
|
||||
ok = (input_slot == INPUT_VALUE)
|
||||
? lm_SaveParamString(cx, &text->current_text, fixed_string)
|
||||
: lm_SaveParamString(cx, &text->default_text, fixed_string);
|
||||
|
||||
JS_free(cx, (char *)fixed_string);
|
||||
if (!ok)
|
||||
goto bad;
|
||||
if (input_slot == INPUT_VALUE && context) {
|
||||
ET_PostManipulateForm(context, (LO_Element *)form_element,
|
||||
EVENT_CHANGE);
|
||||
}
|
||||
break;
|
||||
#if DISABLED_READONLY_SUPPORT
|
||||
case INPUT_DISABLED:
|
||||
text->disabled = JSVAL_TO_BOOLEAN(*vp);
|
||||
if (context) {
|
||||
ET_PostManipulateForm(context, (LO_Element *)form_element,
|
||||
EVENT_CHANGE);
|
||||
}
|
||||
break;
|
||||
case INPUT_READONLY:
|
||||
if (form_element->element_data->type == FORM_TYPE_FILE)
|
||||
break;
|
||||
text->readonly = JSVAL_TO_BOOLEAN(*vp);
|
||||
if (context) {
|
||||
ET_PostManipulateForm(context, (LO_Element *)form_element,
|
||||
EVENT_CHANGE);
|
||||
}
|
||||
break;
|
||||
#endif
|
||||
default:
|
||||
/* Don't mess with option or user-defined property. */
|
||||
goto good;
|
||||
}
|
||||
}
|
||||
break;
|
||||
|
||||
case FORM_TYPE_SELECT_ONE:
|
||||
case FORM_TYPE_SELECT_MULT:
|
||||
{
|
||||
lo_FormElementSelectData *selectData;
|
||||
lo_FormElementOptionData *optionData;
|
||||
JSSelectOption *option;
|
||||
int32 i, new_option_cnt, old_option_cnt;
|
||||
|
||||
selectData = &form_element->element_data->ele_select;
|
||||
switch (slot) {
|
||||
case INPUT_NAME:
|
||||
if (!lm_SaveParamString(cx, &selectData->name, value))
|
||||
goto bad;
|
||||
break;
|
||||
|
||||
case INPUT_LENGTH:
|
||||
new_option_cnt = intval;
|
||||
old_option_cnt = selectData->option_cnt;
|
||||
optionData = (lo_FormElementOptionData *) selectData->options;
|
||||
|
||||
/* Remove truncated slots, or clear extended element data. */
|
||||
if (new_ayer(MWContext *context, int32 wrap_width, int32 parent_layer_id);
|
||||
|
||||
extern void
|
||||
lm_RestoreLayerState(MWContext *context, int32 layer_id,
|
||||
LO_BlockInitializeStruct *param);
|
||||
|
||||
extern PRHashNumber
|
||||
lm_KeyHash(const void *key);
|
||||
|
||||
extern JSBool
|
||||
lm_jsval_to_rgb(JSContext *cx, jsval *vp, LO_Color **rgbp);
|
||||
|
||||
extern JSBool
|
||||
layer_setBgColorProperty(JSContext *cx, JSObject *obj, jsval *vp);
|
||||
|
||||
extern JSObject *
|
||||
lm_GetActiveContainer(MochaDecoder *decoder);
|
||||
|
||||
extern JSBool
|
||||
lm_GetPrincipalsCompromise(JSContext *cx, JSObject *obj);
|
||||
|
||||
extern char *
|
||||
lm_FixNewlines(JSContext *cx, const char *value, JSBool formElement);
|
||||
|
||||
extern JSBool PR_CALLBACK
|
||||
win_open(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
|
||||
|
||||
|
||||
/* defined in libmocha.h */
|
||||
#ifdef JSDEBUGGER
|
||||
|
||||
extern void
|
||||
lm_InitJSDebug(JSRuntime *jsruntime);
|
||||
|
||||
extern void
|
||||
lm_ExitJSDebug(JSRuntime *jsruntime);
|
||||
|
||||
#endif
|
||||
|
||||
#define IS_MESSAGE_WINDOW(context) \
|
||||
(((context)->type == MWContextMail) || \
|
||||
((context)->type == MWContextNews) || \
|
||||
((context)->type == MWContextMailMsg) || \
|
||||
((context)->type == MWContextNewsMsg))
|
||||
|
||||
/* INTL support */
|
||||
|
||||
extern char *
|
||||
lm_StrToLocalEncoding(MWContext * context, JSString * str);
|
||||
|
||||
extern JSString *
|
||||
lm_LocalEncodingToStr(MWContext * context, char * bytes);
|
||||
|
||||
/* end INTL support */
|
||||
|
||||
/* MLM */
|
||||
typedef struct lm_lock_waiter {
|
||||
JSLockReleaseFunc fn;
|
||||
void * data;
|
||||
struct lm_lock_waiter * next;
|
||||
} lm_lock_waiter;
|
||||
|
||||
typedef struct ContextListStr ContextList;
|
||||
|
||||
typedef struct WindowGroup LMWindowGroup;
|
||||
|
||||
struct WindowGroup {
|
||||
LMWindowGroup *next;
|
||||
LMWindowGroup *prev;
|
||||
|
||||
/* XXXMLM - this entry is currently unused; it should eventually hold
|
||||
* a shared JSContext for the thread group.
|
||||
*/
|
||||
JSContext *js_context;
|
||||
|
||||
PRBool interruptCurrentOp;
|
||||
|
||||
PRMonitor *owner_monitor;
|
||||
PRThread *thread;
|
||||
PRThread *owner;
|
||||
lm_lock_waiter *waiting_list;
|
||||
int32 current_count;
|
||||
|
||||
PRBool mozWantsLock;
|
||||
PRBool mozGotLock;
|
||||
|
||||
PRBool hasLock;
|
||||
JSContext *lock_context;
|
||||
|
||||
JSTimeout **js_timeout_insertion_point;
|
||||
JSTimeout *js_timeout_running;
|
||||
|
||||
uint inputRecurring;
|
||||
|
||||
PREventQueue *interpret_queue;
|
||||
QueueStackElement *queue_stack;
|
||||
uint queue_depth;
|
||||
uint queue_count;
|
||||
PRMonitor *queue_monitor;
|
||||
ContextList *mw_contexts;
|
||||
MWContext *current_context;
|
||||
PRBool done;
|
||||
};
|
||||
|
||||
extern void lm_InitWindowGroups(void);
|
||||
extern LMWindowGroup *lm_NewWindowGroup(void);
|
||||
extern void lm_StartWindowGroup(LMWindowGroup *grp);
|
||||
extern void lm_DestroyWindowGroup(LMWindowGroup *grp);
|
||||
extern LMWindowGroup *LM_GetDefaultWindowGroup(MWContext *mwc);
|
||||
extern LMWindowGroup *lm_MWContextToGroup(MWContext *mwc);
|
||||
extern LMWindowGroup *lm_QueueStackToGroup(QueueStackElement *qse);
|
||||
extern PREventQueue *LM_MWContextToQueue(MWContext *mwc);
|
||||
extern PREventQueue *LM_WindowGroupToQueue(LMWindowGroup *lmg);
|
||||
extern ContextList *lm_GetEntryForContext(LMWindowGroup *grp, MWContext *cx);
|
||||
extern void LM_AddContextToGroup(LMWindowGroup *grp, MWContext *cx);
|
||||
extern void LM_RemoveContextFromGroup(MWContext *cx);
|
||||
extern PRBool LM_IsLocked(LMWindowGroup *grp);
|
||||
extern void LM_BeginRequest(LMWindowGroup *grp, JSContext *jsc);
|
||||
extern void LM_EndRequest(LMWindowGroup *grp, JSContext *jsc);
|
||||
|
||||
extern void LM_LockJSByGroup(LMWindowGroup *grp);
|
||||
extern void LM_UnlockJSByGroup(LMWindowGroup *grp);
|
||||
|
||||
extern JSBool lm_inited(void);
|
||||
|
||||
extern JSContext *LM_GetCrippledContext(void);
|
||||
extern MochaDecoder *LM_GetCrippledDecoder(void);
|
||||
extern void LM_SetCrippledDecoder(MochaDecoder *md);
|
||||
extern JSBool LM_ShouldRunGC(JSContext *cx, JSGCStatus status);
|
||||
|
||||
/* MLM */
|
||||
|
||||
#endif /* lm_h___ */
|
||||
675
mozilla/lib/libmocha/lm_cmpnt.c
Normal file
675
mozilla/lib/libmocha/lm_cmpnt.c
Normal file
@@ -0,0 +1,675 @@
|
||||
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* JS reflection of Navigator Components.
|
||||
*
|
||||
* Created: Tom Pixley, 4/22/97
|
||||
*
|
||||
*/
|
||||
|
||||
#include "lm.h"
|
||||
#include "prmem.h"
|
||||
#include "np.h"
|
||||
#include "net.h"
|
||||
#include "fe_proto.h"
|
||||
|
||||
/*
|
||||
* -----------------------------------------------------------------------
|
||||
*
|
||||
* Data types
|
||||
*
|
||||
* -----------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
typedef struct JSComponent
|
||||
{
|
||||
MochaDecoder *decoder;
|
||||
JSObject *obj;
|
||||
JSString *name;
|
||||
ETBoolPtrFunc active_callback;
|
||||
ETVoidPtrFunc startup_callback;
|
||||
} JSComponent;
|
||||
|
||||
typedef struct JSComponentArray
|
||||
{
|
||||
MochaDecoder *decoder;
|
||||
JSObject *obj;
|
||||
jsint length;
|
||||
} JSComponentArray;
|
||||
|
||||
typedef struct JSPreDefComponent
|
||||
{
|
||||
const char *name;
|
||||
ETVerifyComponentFunc func;
|
||||
} JSPreDefComponent;
|
||||
|
||||
static JSPreDefComponent predef_components[] =
|
||||
{
|
||||
{0}
|
||||
};
|
||||
|
||||
/*
|
||||
* -----------------------------------------------------------------------
|
||||
*
|
||||
* Reflection of an installed component.
|
||||
*
|
||||
* -----------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
enum component_slot
|
||||
{
|
||||
COMPONENT_NAME = -1,
|
||||
COMPONENT_ACTIVE = -2
|
||||
};
|
||||
|
||||
|
||||
static JSPropertySpec component_props[] =
|
||||
{
|
||||
{"name", COMPONENT_NAME, JSPROP_ENUMERATE | JSPROP_READONLY},
|
||||
{"active", COMPONENT_ACTIVE, JSPROP_ENUMERATE | JSPROP_READONLY},
|
||||
{0}
|
||||
};
|
||||
|
||||
extern JSClass lm_component_class;
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
component_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
|
||||
{
|
||||
JSComponent *component;
|
||||
JSString *str;
|
||||
jsint slot;
|
||||
|
||||
if (!JSVAL_IS_INT(id))
|
||||
return JS_TRUE;
|
||||
|
||||
slot = JSVAL_TO_INT(id);
|
||||
|
||||
component = JS_GetInstancePrivate(cx, obj, &lm_component_class, NULL);
|
||||
if (!component)
|
||||
return JS_TRUE;
|
||||
|
||||
switch (slot) {
|
||||
case COMPONENT_NAME:
|
||||
str = component->name;
|
||||
if (str)
|
||||
*vp = STRING_TO_JSVAL(str);
|
||||
else
|
||||
*vp = JS_GetEmptyStringValue(cx);
|
||||
break;
|
||||
|
||||
case COMPONENT_ACTIVE:
|
||||
*vp = JSVAL_FALSE;
|
||||
if (ET_moz_CallFunctionBool((ETBoolPtrFunc)component->active_callback, NULL))
|
||||
*vp = JSVAL_TRUE;
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
component_mozilla_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
|
||||
{
|
||||
char *name, *type_str, *get_str;
|
||||
jsval type, func;
|
||||
|
||||
if (!JSVAL_IS_STRING(id))
|
||||
return JS_TRUE;
|
||||
|
||||
name = JS_GetStringBytes(JSVAL_TO_STRING(id));
|
||||
|
||||
type_str = JS_malloc(cx, XP_STRLEN(lm_typePrefix_str) + XP_STRLEN(name) + 1);
|
||||
get_str = JS_malloc(cx, XP_STRLEN(lm_getPrefix_str) + XP_STRLEN(name) + 1);
|
||||
if (!type_str || !get_str)
|
||||
return JS_TRUE;
|
||||
|
||||
XP_STRCPY(type_str, lm_typePrefix_str);
|
||||
XP_STRCAT(type_str, name);
|
||||
XP_STRCPY(get_str, lm_getPrefix_str);
|
||||
XP_STRCAT(get_str, name);
|
||||
|
||||
if (!JS_GetProperty(cx, obj, type_str, &type) ||
|
||||
!JSVAL_IS_INT(type) ||
|
||||
!JS_GetProperty(cx, obj, get_str, &func))
|
||||
return JS_TRUE;
|
||||
|
||||
JS_free(cx, type_str);
|
||||
JS_free(cx, get_str);
|
||||
|
||||
switch(JSVAL_TO_INT(type)) {
|
||||
case ARGTYPE_INT32:
|
||||
*vp = INT_TO_JSVAL((int32)ET_moz_CompGetterFunction((ETCompPropGetterFunc)JSVAL_TO_INT(func), name));
|
||||
break;
|
||||
case ARGTYPE_BOOL:
|
||||
*vp = BOOLEAN_TO_JSVAL((JSBool)ET_moz_CompGetterFunction((ETCompPropGetterFunc)JSVAL_TO_INT(func), name));
|
||||
break;
|
||||
case ARGTYPE_STRING:
|
||||
*vp = STRING_TO_JSVAL(JS_NewStringCopyZ(cx,
|
||||
(char*)ET_moz_CompGetterFunction((ETCompPropGetterFunc)JSVAL_TO_INT(func), name)));
|
||||
break;
|
||||
}
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
component_mozilla_setProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
|
||||
{
|
||||
char *name, *type_str, *set_str, *prop_val;
|
||||
jsval type, func;
|
||||
|
||||
if (!JSVAL_IS_STRING(id))
|
||||
return JS_TRUE;
|
||||
|
||||
name = JS_GetStringBytes(JSVAL_TO_STRING(id));
|
||||
|
||||
type_str = JS_malloc(cx, XP_STRLEN(lm_typePrefix_str) + XP_STRLEN(name) + 1);
|
||||
set_str = JS_malloc(cx, XP_STRLEN(lm_setPrefix_str) + XP_STRLEN(name) + 1);
|
||||
if (!type_str || !set_str)
|
||||
return JS_TRUE;
|
||||
|
||||
XP_STRCPY(type_str, lm_typePrefix_str);
|
||||
XP_STRCAT(type_str, name);
|
||||
XP_STRCPY(set_str, lm_setPrefix_str);
|
||||
XP_STRCAT(set_str, name);
|
||||
if (!JS_GetProperty(cx, obj, type_str, &type) ||
|
||||
!JSVAL_IS_INT(type) ||
|
||||
!JS_GetProperty(cx, obj, set_str, &func))
|
||||
return JS_TRUE;
|
||||
|
||||
JS_free(cx, type_str);
|
||||
JS_free(cx, set_str);
|
||||
|
||||
switch(JSVAL_TO_INT(type)) {
|
||||
case ARGTYPE_INT32:
|
||||
if (JSVAL_IS_INT(*vp))
|
||||
ET_moz_CompSetterFunction((ETCompPropSetterFunc)JSVAL_TO_INT(func), name, (void*)JSVAL_TO_INT(*vp));
|
||||
break;
|
||||
case ARGTYPE_BOOL:
|
||||
if (JSVAL_IS_BOOLEAN(*vp))
|
||||
ET_moz_CompSetterFunction((ETCompPropSetterFunc)JSVAL_TO_INT(func), name, (void*)JSVAL_TO_BOOLEAN(*vp));
|
||||
break;
|
||||
case ARGTYPE_STRING:
|
||||
if (JSVAL_IS_STRING(*vp)) {
|
||||
prop_val = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
|
||||
ET_moz_CompSetterFunction((ETCompPropSetterFunc)JSVAL_TO_INT(func), name, (void*)prop_val);
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
void
|
||||
lm_RegisterComponentProp(const char *comp, const char *targetName,
|
||||
uint8 retType, ETCompPropSetterFunc setter,
|
||||
ETCompPropGetterFunc getter)
|
||||
{
|
||||
JSContext *cx;
|
||||
JSObject *arrayObj, *obj;
|
||||
jsval val;
|
||||
char *type, *set, *get;
|
||||
MochaDecoder *cd = LM_GetCrippledDecoder();
|
||||
|
||||
if (!comp || !targetName || !(cx = cd->js_context))
|
||||
return;
|
||||
|
||||
arrayObj = lm_DefineComponents(cd);
|
||||
if (!arrayObj)
|
||||
return;
|
||||
|
||||
if (!JS_GetProperty(cx, arrayObj, comp, &val) ||
|
||||
!JSVAL_IS_OBJECT(val))
|
||||
return;
|
||||
|
||||
obj = JSVAL_TO_OBJECT(val);
|
||||
|
||||
if (!JS_DefineProperty(cx, obj, targetName, JSVAL_VOID, component_mozilla_getProperty,
|
||||
component_mozilla_setProperty, 0)) {
|
||||
}
|
||||
|
||||
type = JS_malloc(cx, XP_STRLEN(lm_typePrefix_str) + XP_STRLEN(targetName) + 1);
|
||||
if (type) {
|
||||
XP_STRCPY(type, lm_typePrefix_str);
|
||||
XP_STRCAT(type, targetName);
|
||||
if (!JS_DefineProperty(cx, obj, type,
|
||||
INT_TO_JSVAL((int32)retType), 0, 0, JSPROP_READONLY)) {
|
||||
}
|
||||
JS_free(cx, type);
|
||||
}
|
||||
|
||||
get = JS_malloc(cx, XP_STRLEN(lm_getPrefix_str) + XP_STRLEN(targetName) + 1);
|
||||
if (get) {
|
||||
XP_STRCPY(get, lm_getPrefix_str);
|
||||
XP_STRCAT(get, targetName);
|
||||
if (!JS_DefineProperty(cx, obj, get,
|
||||
INT_TO_JSVAL(getter), 0, 0, JSPROP_READONLY)) {
|
||||
}
|
||||
JS_free(cx, get);
|
||||
}
|
||||
|
||||
set = JS_malloc(cx, XP_STRLEN(lm_setPrefix_str) + XP_STRLEN(targetName) + 1);
|
||||
if (set) {
|
||||
XP_STRCPY(set, lm_setPrefix_str);
|
||||
XP_STRCAT(set, targetName);
|
||||
if (!JS_DefineProperty(cx, obj, set,
|
||||
INT_TO_JSVAL(setter), 0, 0, JSPROP_READONLY)) {
|
||||
}
|
||||
JS_free(cx, set);
|
||||
}
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
component_resolve_name(JSContext *cx, JSObject *obj, jsval id)
|
||||
{
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(void)
|
||||
component_finalize(JSContext *cx, JSObject *obj)
|
||||
{
|
||||
JSComponent* component;
|
||||
|
||||
component = JS_GetPrivate(cx, obj);
|
||||
if (!component)
|
||||
return;
|
||||
JS_UnlockGCThing(cx, component->name);
|
||||
DROP_BACK_COUNT(component->decoder);
|
||||
JS_free(cx, component);
|
||||
}
|
||||
|
||||
JSClass lm_component_class =
|
||||
{
|
||||
"Component", JSCLASS_HAS_PRIVATE,
|
||||
JS_PropertyStub, JS_PropertyStub,
|
||||
component_getProperty, component_getProperty, JS_EnumerateStub,
|
||||
component_resolve_name, JS_ConvertStub, component_finalize
|
||||
};
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
component_activate(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
|
||||
{
|
||||
JSComponent *component;
|
||||
|
||||
component = JS_GetInstancePrivate(cx, obj, &lm_component_class, argv);
|
||||
if (!component)
|
||||
return JS_FALSE;
|
||||
|
||||
ET_moz_CallFunctionAsync((ETVoidPtrFunc)component->startup_callback, NULL);
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
static JSFunctionSpec component_methods[] =
|
||||
{
|
||||
{"activate", component_activate, 0},
|
||||
{0}
|
||||
};
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
component_mozilla_method_stub(JSContext *cx, JSObject *obj, uint argc,
|
||||
jsval *argv, jsval *rval)
|
||||
{
|
||||
JSFunction *func;
|
||||
JSObject *func_obj;
|
||||
jsval type, native;
|
||||
uint i;
|
||||
JSCompArg *comp_argv;
|
||||
|
||||
func = JS_ValueToFunction(cx, argv[-2]);
|
||||
func_obj = JS_GetFunctionObject(func);
|
||||
|
||||
if (!JS_GetProperty(cx, func_obj, lm_typePrefix_str, &type) ||
|
||||
!JSVAL_IS_INT(type) ||
|
||||
!JS_GetProperty(cx, func_obj, lm_methodPrefix_str, &native) ||
|
||||
!(comp_argv = JS_malloc(cx, argc * sizeof(JSCompArg))))
|
||||
return JS_TRUE;
|
||||
|
||||
for (i=0; i<argc; i++) {
|
||||
if (JSVAL_IS_INT(argv[i])) {
|
||||
comp_argv[i].type = ARGTYPE_INT32;
|
||||
comp_argv[i].value.intArg = JSVAL_TO_INT(argv[i]);
|
||||
}
|
||||
else if (JSVAL_IS_BOOLEAN(argv[i])) {
|
||||
comp_argv[i].type = ARGTYPE_BOOL;
|
||||
comp_argv[i].value.boolArg = JSVAL_TO_BOOLEAN(argv[i]);
|
||||
}
|
||||
else if (JSVAL_IS_STRING(argv[i])) {
|
||||
comp_argv[i].type = ARGTYPE_STRING;
|
||||
comp_argv[i].value.stringArg = JS_GetStringBytes(JSVAL_TO_STRING(argv[i]));
|
||||
}
|
||||
else {
|
||||
comp_argv[i].type = ARGTYPE_NULL;
|
||||
comp_argv[i].value.intArg = 0;
|
||||
}
|
||||
}
|
||||
|
||||
switch(JSVAL_TO_INT(type)) {
|
||||
case ARGTYPE_NULL:
|
||||
ET_moz_CompMethodFunction((ETCompMethodFunc)JSVAL_TO_INT(native), argc, NULL);
|
||||
*rval = 0;
|
||||
break;
|
||||
case ARGTYPE_INT32:
|
||||
*rval = INT_TO_JSVAL((int32)ET_moz_CompMethodFunction((ETCompMethodFunc)JSVAL_TO_INT(native), argc, comp_argv));
|
||||
break;
|
||||
case ARGTYPE_BOOL:
|
||||
*rval = BOOLEAN_TO_JSVAL((JSBool)ET_moz_CompMethodFunction((ETCompMethodFunc)JSVAL_TO_INT(native), argc, comp_argv));
|
||||
break;
|
||||
case ARGTYPE_STRING:
|
||||
*rval = STRING_TO_JSVAL(JS_NewStringCopyZ(cx,
|
||||
(char*)ET_moz_CompMethodFunction((ETCompMethodFunc)JSVAL_TO_INT(native), argc, comp_argv)));
|
||||
break;
|
||||
}
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
void
|
||||
lm_RegisterComponentMethod(const char *comp, const char *targetName,
|
||||
uint8 retType, ETCompMethodFunc method, int32 argc)
|
||||
{
|
||||
JSContext *cx;
|
||||
JSObject *arrayObj, *obj, *func_obj;
|
||||
JSFunction *func;
|
||||
jsval val;
|
||||
MochaDecoder *cd = LM_GetCrippledDecoder();
|
||||
|
||||
if (!comp || !targetName || !(cx = cd->js_context))
|
||||
return;
|
||||
|
||||
arrayObj = lm_DefineComponents(cd);
|
||||
if (!arrayObj)
|
||||
return;
|
||||
|
||||
if (!JS_GetProperty(cx, arrayObj, comp, &val) ||
|
||||
!JSVAL_IS_OBJECT(val))
|
||||
return;
|
||||
|
||||
obj = JSVAL_TO_OBJECT(val);
|
||||
|
||||
if (!(func = JS_DefineFunction(cx, obj, targetName, component_mozilla_method_stub, argc, 0))){
|
||||
}
|
||||
|
||||
func_obj = JS_GetFunctionObject(func);
|
||||
|
||||
if (!JS_DefineProperty(cx, func_obj, lm_typePrefix_str,
|
||||
INT_TO_JSVAL((int32)retType), 0, 0, JSPROP_READONLY))
|
||||
return;
|
||||
if (!JS_DefineProperty(cx, func_obj, lm_methodPrefix_str,
|
||||
INT_TO_JSVAL(method), 0, 0, JSPROP_READONLY))
|
||||
return;
|
||||
if (!JS_DefineProperty(cx, func_obj, lm_methodArgc_str,
|
||||
INT_TO_JSVAL(argc), 0, 0, JSPROP_READONLY))
|
||||
return;
|
||||
}
|
||||
|
||||
/* Constructor method for a JSComponent object */
|
||||
static JSComponent*
|
||||
component_create_self(JSContext *cx, MochaDecoder* decoder, JSComponent *component, const char *name)
|
||||
{
|
||||
JSObject *obj;
|
||||
|
||||
/* JSComponent may be malloc'd previous to this to make it easier
|
||||
* to fill in the struct with data from the Mozilla thread
|
||||
*/
|
||||
if (!component) {
|
||||
component = JS_malloc(cx, sizeof(JSComponent));
|
||||
if (!component)
|
||||
return NULL;
|
||||
}
|
||||
|
||||
obj = JS_NewObject(cx, &lm_component_class, NULL, NULL);
|
||||
if (!obj || !JS_SetPrivate(cx, obj, component)) {
|
||||
JS_free(cx, component);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
if (!JS_DefineProperties(cx, obj, component_props))
|
||||
return NULL;
|
||||
|
||||
if (!JS_DefineFunctions(cx, obj, component_methods))
|
||||
return NULL;
|
||||
|
||||
/* Fill out static property fields */
|
||||
component->decoder = HOLD_BACK_COUNT(decoder);
|
||||
component->obj = obj;
|
||||
|
||||
component->name = JS_NewStringCopyZ(cx, name);
|
||||
if (!component->name || !JS_LockGCThing(cx, component->name))
|
||||
return NULL;
|
||||
|
||||
return component;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* -----------------------------------------------------------------------
|
||||
*
|
||||
* Reflection of the list of installed components.
|
||||
* The only static property is the array length;
|
||||
* the array elements (JSComponents) are added
|
||||
* lazily when referenced.
|
||||
*
|
||||
* -----------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
enum componentarray_slot
|
||||
{
|
||||
COMPONENTLIST_ARRAY_LENGTH = -1
|
||||
};
|
||||
|
||||
static JSPropertySpec componentarray_props[] =
|
||||
{
|
||||
{"length", COMPONENTLIST_ARRAY_LENGTH, JSPROP_READONLY},
|
||||
{0}
|
||||
};
|
||||
|
||||
/* Look up the component for the specified slot of the plug-in list */
|
||||
static JSComponent*
|
||||
componentarray_create_component(JSContext *cx, JSComponentArray *array,
|
||||
JSComponent *component, const char *targetName, jsint targetSlot)
|
||||
{
|
||||
component = component_create_self(cx, array->decoder, component, targetName);
|
||||
if (component) {
|
||||
char *name;
|
||||
jsval val;
|
||||
|
||||
name = JS_GetStringBytes(component->name);
|
||||
val = OBJECT_TO_JSVAL(component->obj);
|
||||
JS_DefineProperty(cx, array->obj, name, val, NULL, NULL,
|
||||
JSPROP_ENUMERATE);
|
||||
JS_AliasElement(cx, array->obj, name, targetSlot);
|
||||
array->length++;
|
||||
return component;
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
extern JSClass lm_component_array_class;
|
||||
|
||||
void
|
||||
lm_RegisterComponent(const char *targetName, ETBoolPtrFunc active_callback,
|
||||
ETVoidPtrFunc startup_callback)
|
||||
{
|
||||
JSContext *cx;
|
||||
JSObject *arrayObj;
|
||||
JSComponentArray *array;
|
||||
JSComponent *component;
|
||||
jsval val;
|
||||
MochaDecoder *cd = LM_GetCrippledDecoder();
|
||||
|
||||
if (!(cx = cd->js_context) || !targetName)
|
||||
return;
|
||||
|
||||
arrayObj = lm_DefineComponents(cd);
|
||||
if (!arrayObj)
|
||||
return;
|
||||
|
||||
array = JS_GetInstancePrivate(cx, arrayObj, &lm_component_array_class, NULL);
|
||||
if (!array)
|
||||
return;
|
||||
|
||||
if (JS_GetProperty(cx, arrayObj, targetName, &val) && JSVAL_IS_OBJECT(val)) {
|
||||
/* We already have a component by this name. Update the active and
|
||||
* startup callback funcs in case ours are out of date
|
||||
*/
|
||||
component = JS_GetPrivate(cx, JSVAL_TO_OBJECT(val));
|
||||
if (!component)
|
||||
return;
|
||||
|
||||
component->active_callback = active_callback;
|
||||
component->startup_callback = startup_callback;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
component = JS_malloc(cx, sizeof(JSComponent));
|
||||
if (!component)
|
||||
return;
|
||||
|
||||
component->active_callback = active_callback;
|
||||
component->startup_callback = startup_callback;
|
||||
|
||||
componentarray_create_component(cx, array, component, targetName, array->length);
|
||||
}
|
||||
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
componentarray_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
|
||||
{
|
||||
JSComponentArray *array;
|
||||
jsint slot;
|
||||
|
||||
if (!JSVAL_IS_INT(id))
|
||||
return JS_TRUE;
|
||||
|
||||
slot = JSVAL_TO_INT(id);
|
||||
|
||||
array = JS_GetInstancePrivate(cx, obj, &lm_component_array_class, NULL);
|
||||
if (!array)
|
||||
return JS_TRUE;
|
||||
|
||||
switch (slot) {
|
||||
case COMPONENTLIST_ARRAY_LENGTH:
|
||||
*vp = INT_TO_JSVAL(array->length);
|
||||
break;
|
||||
|
||||
default:
|
||||
/* Don't mess with a user-defined property. */
|
||||
if (slot >= 0 && slot < (jsint) array->length) {
|
||||
|
||||
/* Search for an existing JSComponent for this slot */
|
||||
JSObject* componentObj = NULL;
|
||||
jsval val = *vp;
|
||||
|
||||
if (JSVAL_IS_OBJECT(val)) {
|
||||
componentObj = JSVAL_TO_OBJECT(val);
|
||||
}
|
||||
else {
|
||||
JSComponent* component;
|
||||
component = componentarray_create_component(cx, array, NULL,
|
||||
NULL, slot);
|
||||
if (component)
|
||||
componentObj = component->obj;
|
||||
}
|
||||
|
||||
*vp = OBJECT_TO_JSVAL(componentObj);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(void)
|
||||
componentarray_finalize(JSContext *cx, JSObject *obj)
|
||||
{
|
||||
JSComponentArray* array;
|
||||
|
||||
array = JS_GetPrivate(cx, obj);
|
||||
if (!array)
|
||||
return;
|
||||
DROP_BACK_COUNT(array->decoder);
|
||||
JS_free(cx, array);
|
||||
}
|
||||
|
||||
JSClass lm_component_array_class =
|
||||
{
|
||||
"ComponentArray", JSCLASS_HAS_PRIVATE,
|
||||
JS_PropertyStub, JS_PropertyStub,
|
||||
componentarray_getProperty, componentarray_getProperty, JS_EnumerateStub,
|
||||
JS_ResolveStub, JS_ConvertStub, componentarray_finalize
|
||||
};
|
||||
|
||||
|
||||
JSObject*
|
||||
lm_DefineComponents(MochaDecoder *decoder)
|
||||
{
|
||||
JSObject *obj;
|
||||
JSComponentArray *array;
|
||||
JSContext *cx = decoder->js_context;
|
||||
JSPreDefComponent def_comps;
|
||||
JSComponent *component;
|
||||
jsint slot;
|
||||
|
||||
obj = decoder->components;
|
||||
if (obj)
|
||||
return obj;
|
||||
|
||||
array = JS_malloc(cx, sizeof(JSComponentArray));
|
||||
if (!array)
|
||||
return NULL;
|
||||
XP_BZERO(array, sizeof *array);
|
||||
|
||||
obj = JS_NewObject(cx, &lm_component_array_class, NULL,
|
||||
decoder->window_object);
|
||||
if (!obj || !JS_SetPrivate(cx, obj, array)) {
|
||||
JS_free(cx, array);
|
||||
return NULL;
|
||||
}
|
||||
if (!JS_DefineProperties(cx, obj, componentarray_props))
|
||||
return NULL;
|
||||
|
||||
array->decoder = HOLD_BACK_COUNT(decoder);
|
||||
array->obj = obj;
|
||||
|
||||
/* Components can be added dynamically but some are predefined */
|
||||
slot = 0;
|
||||
array->length = 0;
|
||||
def_comps = predef_components[slot];
|
||||
while (def_comps.name) {
|
||||
component = JS_malloc(cx, sizeof(JSComponent));
|
||||
if (!component)
|
||||
return NULL;
|
||||
|
||||
if (ET_moz_VerifyComponentFunction(def_comps.func, &(component->active_callback),
|
||||
&(component->startup_callback))) {
|
||||
componentarray_create_component(cx, array, component, def_comps.name, array->length);
|
||||
}
|
||||
else {
|
||||
/*Component call failed somewhere.*/
|
||||
JS_free(cx, component);
|
||||
}
|
||||
def_comps = predef_components[++slot];
|
||||
}
|
||||
return obj;
|
||||
}
|
||||
854
mozilla/lib/libmocha/lm_img.c
Normal file
854
mozilla/lib/libmocha/lm_img.c
Normal file
@@ -0,0 +1,854 @@
|
||||
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
/*
|
||||
* Image reflection and event notification
|
||||
*
|
||||
* Scott Furman, 3/30/96
|
||||
*/
|
||||
|
||||
#include "lm.h"
|
||||
|
||||
#include "lo_ele.h"
|
||||
#include "prtypes.h"
|
||||
#include "pa_tags.h"
|
||||
#include "layout.h"
|
||||
|
||||
#define IL_CLIENT
|
||||
#include "libimg.h" /* Image Library public API. */
|
||||
|
||||
enum image_array_slot {
|
||||
IMAGE_ARRAY_LENGTH = -1
|
||||
};
|
||||
|
||||
static JSPropertySpec image_array_props[] = {
|
||||
{lm_length_str, IMAGE_ARRAY_LENGTH,
|
||||
JSPROP_ENUMERATE | JSPROP_READONLY | JSPROP_PERMANENT},
|
||||
{0}
|
||||
};
|
||||
|
||||
extern JSClass lm_image_array_class;
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
image_array_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
|
||||
{
|
||||
JSObjectArray *array;
|
||||
MochaDecoder *decoder;
|
||||
MWContext *context;
|
||||
jsint count, slot;
|
||||
LO_ImageStruct *image;
|
||||
int32 active_layer_id;
|
||||
|
||||
if (!JSVAL_IS_INT(id))
|
||||
return JS_TRUE;
|
||||
|
||||
slot = JSVAL_TO_INT(id);
|
||||
|
||||
array = JS_GetInstancePrivate(cx, obj, &lm_image_array_class, NULL);
|
||||
if (!array)
|
||||
return JS_TRUE;
|
||||
decoder = array->decoder;
|
||||
context = decoder->window_context;
|
||||
if (!context)
|
||||
return JS_TRUE;
|
||||
|
||||
LO_LockLayout();
|
||||
switch (slot) {
|
||||
case IMAGE_ARRAY_LENGTH:
|
||||
active_layer_id = LM_GetActiveLayer(context);
|
||||
LM_SetActiveLayer(context, array->layer_id);
|
||||
count = LO_EnumerateImages(context, array->layer_id);
|
||||
LM_SetActiveLayer(context, active_layer_id);
|
||||
if (count > array->length)
|
||||
array->length = count;
|
||||
*vp = INT_TO_JSVAL(count);
|
||||
break;
|
||||
|
||||
default:
|
||||
if (slot < 0) {
|
||||
/* Don't mess with user-defined or method properties. */
|
||||
LO_UnlockLayout();
|
||||
return JS_TRUE;
|
||||
}
|
||||
if (slot >= array->length)
|
||||
array->length = slot + 1;
|
||||
image = LO_GetImageByIndex(context, array->layer_id, (uint)slot);
|
||||
if (image) {
|
||||
*vp = OBJECT_TO_JSVAL(LM_ReflectImage(context, image, NULL,
|
||||
array->layer_id,
|
||||
(uint)slot));
|
||||
}
|
||||
break;
|
||||
}
|
||||
LO_UnlockLayout();
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(void)
|
||||
image_array_finalize(JSContext *cx, JSObject *obj)
|
||||
{
|
||||
JSObjectArray *array;
|
||||
|
||||
array = JS_GetPrivate(cx, obj);
|
||||
if (!array)
|
||||
return;
|
||||
DROP_BACK_COUNT(array->decoder);
|
||||
JS_free(cx, array);
|
||||
}
|
||||
|
||||
JSClass lm_image_array_class = {
|
||||
"ImageArray", JSCLASS_HAS_PRIVATE,
|
||||
JS_PropertyStub, JS_PropertyStub,
|
||||
image_array_getProperty, image_array_getProperty, JS_EnumerateStub,
|
||||
JS_ResolveStub, JS_ConvertStub, image_array_finalize
|
||||
};
|
||||
|
||||
enum image_slot {
|
||||
IMAGE_NAME = -2,
|
||||
IMAGE_SRC = -3,
|
||||
IMAGE_LOWSRC = -4,
|
||||
IMAGE_X = -5,
|
||||
IMAGE_Y = -6,
|
||||
IMAGE_HEIGHT = -7,
|
||||
IMAGE_WIDTH = -8,
|
||||
IMAGE_BORDER = -9,
|
||||
IMAGE_VSPACE = -10,
|
||||
IMAGE_HSPACE = -11,
|
||||
IMAGE_COMPLETE = -12
|
||||
};
|
||||
|
||||
static JSPropertySpec image_props[] = {
|
||||
{"name", IMAGE_NAME, JSPROP_ENUMERATE | JSPROP_READONLY},
|
||||
{"src", IMAGE_SRC, JSPROP_ENUMERATE},
|
||||
{"lowsrc", IMAGE_LOWSRC, JSPROP_ENUMERATE},
|
||||
{"x", IMAGE_X, JSPROP_ENUMERATE | JSPROP_READONLY},
|
||||
{"y", IMAGE_Y, JSPROP_ENUMERATE | JSPROP_READONLY},
|
||||
{"height", IMAGE_HEIGHT, JSPROP_ENUMERATE | JSPROP_READONLY},
|
||||
{"width", IMAGE_WIDTH, JSPROP_ENUMERATE | JSPROP_READONLY},
|
||||
{"border", IMAGE_BORDER, JSPROP_ENUMERATE | JSPROP_READONLY},
|
||||
{"vspace", IMAGE_VSPACE, JSPROP_ENUMERATE | JSPROP_READONLY},
|
||||
{"hspace", IMAGE_HSPACE, JSPROP_ENUMERATE | JSPROP_READONLY},
|
||||
{"complete", IMAGE_COMPLETE, JSPROP_ENUMERATE | JSPROP_READONLY},
|
||||
{0}
|
||||
};
|
||||
|
||||
/*
|
||||
* Base image element type.
|
||||
*/
|
||||
typedef struct JSImage {
|
||||
JSEventReceiver receiver;
|
||||
MochaDecoder *decoder;
|
||||
LO_ImageStruct *image_data; /* 0 unless made by new Image() */
|
||||
uint8 pending_events;
|
||||
int32 layer_id;
|
||||
uint index;
|
||||
JSBool complete; /* Finished loading or aborted */
|
||||
JSString *name;
|
||||
} JSImage;
|
||||
|
||||
#define GET_IMAGE_DATA(context, image) \
|
||||
((image)->image_data ? (image)->image_data \
|
||||
: LO_GetImageByIndex((context), (image)->layer_id, (image)->index))
|
||||
|
||||
extern JSClass lm_image_class;
|
||||
|
||||
/*
|
||||
* Force the mozilla event queue to flush to make sure any image-set-src
|
||||
* events have been processed
|
||||
*/
|
||||
PR_STATIC_CALLBACK(void)
|
||||
lm_img_src_sync(void * data)
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
image_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
|
||||
{
|
||||
JSImage *image;
|
||||
LO_ImageStruct *image_data;
|
||||
enum image_slot image_slot;
|
||||
JSString *str;
|
||||
jsint slot;
|
||||
|
||||
if (!JSVAL_IS_INT(id))
|
||||
return JS_TRUE;
|
||||
|
||||
slot = JSVAL_TO_INT(id);
|
||||
|
||||
image = JS_GetInstancePrivate(cx, obj, &lm_image_class, NULL);
|
||||
if (!image)
|
||||
return JS_TRUE;
|
||||
image_data = GET_IMAGE_DATA(image->decoder->window_context, image);
|
||||
if (!image_data)
|
||||
return JS_TRUE; /* Try to handle this case gracefully. */
|
||||
|
||||
image_slot = slot;
|
||||
if (image_slot == IMAGE_SRC || image_slot == IMAGE_LOWSRC) {
|
||||
if (!lm_CheckPermissions(cx, obj, JSTARGET_UNIVERSAL_BROWSER_READ))
|
||||
return JS_FALSE;
|
||||
}
|
||||
|
||||
switch (image_slot) {
|
||||
case IMAGE_NAME:
|
||||
if (image->name)
|
||||
*vp = STRING_TO_JSVAL(image->name);
|
||||
else
|
||||
*vp = JSVAL_NULL;
|
||||
break;
|
||||
|
||||
case IMAGE_SRC:
|
||||
if (image_data->pending_mocha_event) {
|
||||
ET_moz_CallFunction(lm_img_src_sync, NULL);
|
||||
image_data->pending_mocha_event = PR_FALSE;
|
||||
}
|
||||
str = JS_NewStringCopyZ(cx, (char*)image_data->image_url);
|
||||
if (!str)
|
||||
return JS_FALSE;
|
||||
*vp = STRING_TO_JSVAL(str);
|
||||
break;
|
||||
|
||||
case IMAGE_LOWSRC:
|
||||
if (image_data->pending_mocha_event) {
|
||||
ET_moz_CallFunction(lm_img_src_sync, NULL);
|
||||
image_data->pending_mocha_event = PR_FALSE;
|
||||
}
|
||||
str = JS_NewStringCopyZ(cx, (char*)image_data->lowres_image_url);
|
||||
if (!str)
|
||||
return JS_FALSE;
|
||||
*vp = STRING_TO_JSVAL(str);
|
||||
break;
|
||||
|
||||
case IMAGE_X:
|
||||
*vp = INT_TO_JSVAL(image_data->x + image_data->x_offset);
|
||||
break;
|
||||
|
||||
case IMAGE_Y:
|
||||
*vp = INT_TO_JSVAL(image_data->y + image_data->y_offset);
|
||||
break;
|
||||
|
||||
case IMAGE_HEIGHT:
|
||||
*vp = INT_TO_JSVAL(image_data->height);
|
||||
break;
|
||||
|
||||
case IMAGE_WIDTH:
|
||||
*vp = INT_TO_JSVAL(image_data->width);
|
||||
break;
|
||||
|
||||
case IMAGE_BORDER:
|
||||
*vp = INT_TO_JSVAL(image_data->border_width);
|
||||
break;
|
||||
|
||||
case IMAGE_HSPACE:
|
||||
*vp = INT_TO_JSVAL(image_data->border_horiz_space);
|
||||
break;
|
||||
|
||||
case IMAGE_VSPACE:
|
||||
*vp = INT_TO_JSVAL(image_data->border_vert_space);
|
||||
break;
|
||||
|
||||
case IMAGE_COMPLETE:
|
||||
*vp = BOOLEAN_TO_JSVAL(image->complete);
|
||||
break;
|
||||
|
||||
default:
|
||||
/* Don't mess with a user-defined or method property. */
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
static JSBool
|
||||
image_set_src(JSImage *image, const char *str, LO_ImageStruct *image_data)
|
||||
{
|
||||
MochaDecoder *decoder;
|
||||
MWContext *context;
|
||||
IL_GroupContext *img_cx;
|
||||
|
||||
decoder = image->decoder;
|
||||
context = decoder->window_context;
|
||||
img_cx = decoder->image_context;
|
||||
|
||||
if (!context) return JS_TRUE;
|
||||
|
||||
image_data->pending_mocha_event = PR_TRUE;
|
||||
image_data->image_attr->attrmask |= LO_ATTR_MOCHA_IMAGE;
|
||||
|
||||
ET_il_GetImage(str, context, img_cx, image_data, NET_DONT_RELOAD);
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
image_setProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
|
||||
{
|
||||
JSBool ok;
|
||||
JSImage *image;
|
||||
MochaDecoder *decoder;
|
||||
MWContext *context;
|
||||
LO_ImageStruct *image_data;
|
||||
enum image_slot image_slot;
|
||||
const char *url;
|
||||
jsint slot;
|
||||
|
||||
image = JS_GetInstancePrivate(cx, obj, &lm_image_class, NULL);
|
||||
if (!image)
|
||||
return JS_TRUE;
|
||||
decoder = image->decoder;
|
||||
context = decoder->window_context;
|
||||
if (!context)
|
||||
return JS_TRUE;
|
||||
|
||||
if (!JSVAL_IS_INT(id))
|
||||
return JS_TRUE;
|
||||
|
||||
slot = JSVAL_TO_INT(id);
|
||||
|
||||
image_data = GET_IMAGE_DATA(context, image);
|
||||
if (!image_data)
|
||||
return JS_TRUE; /* Try to handle this case gracefully. */
|
||||
|
||||
image_slot = slot;
|
||||
switch (image_slot) {
|
||||
case IMAGE_SRC:
|
||||
case IMAGE_LOWSRC:
|
||||
if (!lm_CheckPermissions(cx, obj, JSTARGET_UNIVERSAL_BROWSER_WRITE))
|
||||
return JS_FALSE;
|
||||
|
||||
if (JSVAL_IS_NULL(*vp)) {
|
||||
url = NULL;
|
||||
} else {
|
||||
if (!JSVAL_IS_STRING(*vp) &&
|
||||
!JS_ConvertValue(cx, *vp, JSTYPE_STRING, vp))
|
||||
return JS_FALSE;
|
||||
|
||||
url = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
|
||||
url = lm_CheckURL(cx, url, JS_TRUE); /* will allocate new string */
|
||||
if (!url)
|
||||
return JS_FALSE;
|
||||
}
|
||||
|
||||
if (image_slot == IMAGE_SRC) {
|
||||
ok = image_set_src(image, url, image_data);
|
||||
} else if (url) {
|
||||
ok = lm_SaveParamString(cx, &image_data->lowres_image_url, url);
|
||||
}
|
||||
|
||||
if (url)
|
||||
XP_FREE((void *) url);
|
||||
|
||||
if (!ok)
|
||||
return JS_FALSE;
|
||||
|
||||
/*
|
||||
* don't call image_getProperty so that we don't immediately
|
||||
* turn around and block
|
||||
*/
|
||||
return JS_TRUE;
|
||||
break;
|
||||
|
||||
case IMAGE_NAME:
|
||||
case IMAGE_X:
|
||||
case IMAGE_Y:
|
||||
case IMAGE_HEIGHT:
|
||||
case IMAGE_WIDTH:
|
||||
case IMAGE_BORDER:
|
||||
case IMAGE_VSPACE:
|
||||
case IMAGE_HSPACE:
|
||||
case IMAGE_COMPLETE:
|
||||
/* These are immutable. */
|
||||
break;
|
||||
}
|
||||
|
||||
return image_getProperty(cx, obj, id, vp);
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(void)
|
||||
image_finalize(JSContext *cx, JSObject *obj)
|
||||
{
|
||||
JSImage *image;
|
||||
LO_ImageStruct *image_data;
|
||||
MochaDecoder *decoder;
|
||||
MWContext *context;
|
||||
|
||||
image = JS_GetPrivate(cx, obj);
|
||||
if (!image)
|
||||
return;
|
||||
|
||||
image_data = image->image_data;
|
||||
decoder = image->decoder;
|
||||
context = decoder->window_context;
|
||||
if (image_data) {
|
||||
/* If this is a layer background image or a reflection of an
|
||||
existing layout image, then layout will take care of
|
||||
destroying the image. For anonymous images, however,
|
||||
we need to handle destruction here. */
|
||||
if (!image_data->layer) {
|
||||
ET_PostFreeImageElement(context, image_data);
|
||||
XP_FREE(image_data->image_attr);
|
||||
XP_FREE(image_data);
|
||||
}
|
||||
} else {
|
||||
if (context) {
|
||||
LO_LockLayout();
|
||||
image_data = LO_GetImageByIndex(context, image->layer_id,
|
||||
image->index);
|
||||
if (image_data && image_data->mocha_object == obj)
|
||||
image_data->mocha_object = NULL;
|
||||
LO_UnlockLayout();
|
||||
}
|
||||
}
|
||||
DROP_BACK_COUNT(decoder);
|
||||
|
||||
JS_UnlockGCThing(cx, image->name);
|
||||
JS_free(cx, image);
|
||||
}
|
||||
|
||||
JSClass lm_image_class = {
|
||||
"Image", JSCLASS_HAS_PRIVATE,
|
||||
JS_PropertyStub, JS_PropertyStub, image_getProperty, image_setProperty,
|
||||
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, image_finalize
|
||||
};
|
||||
|
||||
/* Fill in native, private part of JS image */
|
||||
static JSImage *
|
||||
init_image_object(JSContext *cx, JSObject *obj, LO_ImageStruct *image_data)
|
||||
{
|
||||
JSImage *image;
|
||||
MochaDecoder *decoder;
|
||||
|
||||
image = JS_malloc(cx, sizeof *image);
|
||||
if (!image)
|
||||
return NULL;
|
||||
XP_BZERO(image, sizeof *image);
|
||||
|
||||
image->image_data = image_data;
|
||||
decoder = JS_GetPrivate(cx, JS_GetGlobalObject(cx));
|
||||
image->decoder = HOLD_BACK_COUNT(decoder);
|
||||
image_data->mocha_object = obj;
|
||||
|
||||
/* Events are never blocked for anonymous images
|
||||
since there is no associated layout. */
|
||||
image->pending_events = PR_BIT(LM_IMGUNBLOCK);
|
||||
if (!JS_SetPrivate(cx, obj, image))
|
||||
return NULL;
|
||||
|
||||
return image;
|
||||
}
|
||||
|
||||
JSObject *
|
||||
lm_NewImage(JSContext *cx,
|
||||
LO_ImageStruct *image_data)
|
||||
{
|
||||
JSObject *obj, *outer_obj;
|
||||
MochaDecoder *decoder;
|
||||
decoder = JS_GetPrivate(cx, JS_GetGlobalObject(cx));
|
||||
outer_obj = lm_GetOuterObject(decoder);
|
||||
|
||||
obj = JS_NewObject(cx, &lm_image_class, decoder->image_prototype,
|
||||
outer_obj);
|
||||
if (!init_image_object(cx, obj, image_data))
|
||||
return NULL;
|
||||
|
||||
return obj;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
Image(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
|
||||
{
|
||||
jsint width, height;
|
||||
LO_ImageStruct *image_data;
|
||||
|
||||
XP_ASSERT(JS_InstanceOf(cx, obj, &lm_image_class, NULL));
|
||||
|
||||
height = width = 0;
|
||||
|
||||
if (argc > 0) {
|
||||
if (argc != 2) {
|
||||
JS_ReportError(cx, lm_argc_err_str);
|
||||
return JS_FALSE;
|
||||
}
|
||||
if (!JSVAL_IS_INT(argv[0]) ||
|
||||
!JSVAL_IS_INT(argv[1])) {
|
||||
return JS_FALSE;
|
||||
}
|
||||
width = JSVAL_TO_INT(argv[0]);
|
||||
height = JSVAL_TO_INT(argv[1]);
|
||||
}
|
||||
|
||||
/* Allocate dummy layout structure. This is not really
|
||||
used by layout, but the front-ends and the imagelib
|
||||
need it as a handle on an image instance. */
|
||||
image_data = XP_NEW_ZAP(LO_ImageStruct);
|
||||
if (!image_data) {
|
||||
JS_ReportOutOfMemory(cx);
|
||||
return JS_FALSE;
|
||||
}
|
||||
image_data->image_attr = XP_NEW_ZAP(LO_ImageAttr);
|
||||
if (!image_data->image_attr) {
|
||||
XP_FREE(image_data);
|
||||
JS_ReportOutOfMemory(cx);
|
||||
return JS_FALSE;
|
||||
}
|
||||
|
||||
image_data->type = LO_IMAGE;
|
||||
|
||||
/* Fake layout ID, guaranteed not to match any real layout element */
|
||||
image_data->ele_id = -1;
|
||||
|
||||
if (!init_image_object(cx, obj, image_data)) {
|
||||
XP_FREE(image_data->image_attr);
|
||||
XP_FREE(image_data);
|
||||
return JS_FALSE;
|
||||
}
|
||||
|
||||
/* Process arguments */
|
||||
|
||||
/* Width & Height */
|
||||
if (argc == 2) {
|
||||
image_data->width = (int)width;
|
||||
image_data->height = (int)height;
|
||||
}
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
static JSObject *
|
||||
reflect_image_array(MochaDecoder *decoder, JSObject *document)
|
||||
{
|
||||
JSContext *cx;
|
||||
JSObjectArray *array;
|
||||
JSObject *obj;
|
||||
JSDocument *doc;
|
||||
|
||||
cx = decoder->js_context;
|
||||
doc = JS_GetPrivate(cx, document);
|
||||
if (!doc)
|
||||
return NULL;
|
||||
|
||||
array = JS_malloc(cx, sizeof *array);
|
||||
if (!array)
|
||||
return NULL;
|
||||
XP_BZERO(array, sizeof *array);
|
||||
|
||||
obj = JS_NewObject(cx, &lm_image_array_class, NULL, document);
|
||||
if (!obj || !JS_SetPrivate(cx, obj, array)) {
|
||||
LM_PutMochaDecoder(decoder);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
if (!JS_DefineProperties(cx, obj, image_array_props))
|
||||
return NULL;
|
||||
|
||||
array->decoder = HOLD_BACK_COUNT(decoder);
|
||||
array->layer_id = doc->layer_id;
|
||||
return obj;
|
||||
}
|
||||
|
||||
JSObject *
|
||||
lm_GetImageArray(MochaDecoder *decoder, JSObject *document)
|
||||
{
|
||||
JSObject *obj;
|
||||
JSDocument *doc;
|
||||
|
||||
doc = JS_GetPrivate(decoder->js_context, document);
|
||||
if (!doc)
|
||||
return NULL;
|
||||
|
||||
obj = doc->images;
|
||||
if (obj)
|
||||
return obj;
|
||||
obj = reflect_image_array(decoder, document);
|
||||
doc->images = obj;
|
||||
return obj;
|
||||
}
|
||||
|
||||
JSObject *
|
||||
LM_ReflectImage(MWContext *context, LO_ImageStruct *image_data,
|
||||
PA_Tag * tag, int32 layer_id, uint index)
|
||||
{
|
||||
JSObject *obj, *array_obj, *outer_obj, *document;
|
||||
MochaDecoder *decoder;
|
||||
JSContext *cx;
|
||||
JSImage *image;
|
||||
PA_Block name = NULL;
|
||||
lo_TopState *top_state;
|
||||
PRHashTable *map;
|
||||
|
||||
image_data = LO_GetImageByIndex(context, layer_id, index);
|
||||
XP_ASSERT(image_data);
|
||||
if (! image_data)
|
||||
return NULL;
|
||||
|
||||
obj = image_data->mocha_object;
|
||||
if (obj)
|
||||
return obj;
|
||||
|
||||
decoder = LM_GetMochaDecoder(context);
|
||||
if (!decoder)
|
||||
return NULL;
|
||||
cx = decoder->js_context;
|
||||
|
||||
top_state = lo_GetMochaTopState(context);
|
||||
if (top_state->resize_reload) {
|
||||
map = lm_GetIdToObjectMap(decoder);
|
||||
|
||||
if (map)
|
||||
obj = (JSObject *)PR_HashTableLookup(map,
|
||||
LM_GET_MAPPING_KEY(LM_IMAGES, layer_id, index));
|
||||
if (obj) {
|
||||
image_data->mocha_object = obj;
|
||||
goto done;
|
||||
}
|
||||
}
|
||||
|
||||
/* Get the document object that will hold this link */
|
||||
document = lm_GetDocumentFromLayerId(decoder, layer_id);
|
||||
if (!document)
|
||||
goto done;
|
||||
|
||||
array_obj = lm_GetImageArray(decoder, document);
|
||||
if (!array_obj)
|
||||
goto done;
|
||||
|
||||
image = JS_malloc(cx, sizeof *image);
|
||||
if (!image)
|
||||
goto done;
|
||||
|
||||
XP_BZERO(image, sizeof *image);
|
||||
|
||||
/* if we got a tag passed in try to get the name out of there */
|
||||
name = lo_FetchParamValue(context, tag, PARAM_NAME);
|
||||
|
||||
outer_obj = lm_GetOuterObject(decoder);
|
||||
|
||||
obj = JS_NewObject(cx, &lm_image_class, decoder->image_prototype,
|
||||
outer_obj);
|
||||
if (!obj || !JS_SetPrivate(cx, obj, image)) {
|
||||
JS_free(cx, image);
|
||||
goto done;
|
||||
}
|
||||
|
||||
if (name) {
|
||||
JSObject *doc_obj;
|
||||
extern JSClass lm_form_class;
|
||||
|
||||
if (!JS_DefineProperty(cx, outer_obj, (const char *) name,
|
||||
OBJECT_TO_JSVAL(obj), NULL, NULL,
|
||||
JSPROP_ENUMERATE|JSPROP_READONLY)) {
|
||||
obj = NULL;
|
||||
goto done;
|
||||
}
|
||||
/* XXX backward compatibility with 3.0 bug: lo_BlockedImageLayout
|
||||
would eagerly reflect images outside of any active form, so
|
||||
they'd end up in document scope. */
|
||||
if (JS_GetClass(cx, outer_obj) == &lm_form_class &&
|
||||
(doc_obj = JS_GetParent(cx, outer_obj)) != NULL &&
|
||||
!JS_DefineProperty(cx, doc_obj, (const char *) name,
|
||||
OBJECT_TO_JSVAL(obj), NULL, NULL,
|
||||
JSPROP_ENUMERATE|JSPROP_READONLY)) {
|
||||
obj = NULL;
|
||||
goto done;
|
||||
}
|
||||
}
|
||||
|
||||
image->decoder = HOLD_BACK_COUNT(decoder);
|
||||
image->index = index;
|
||||
image->layer_id = layer_id;
|
||||
image->name = JS_NewStringCopyZ(cx, (const char *) name);
|
||||
if (!JS_LockGCThing(cx, image->name)) {
|
||||
obj = NULL;
|
||||
goto done;
|
||||
}
|
||||
image_data->mocha_object = obj;
|
||||
|
||||
if (!lm_AddObjectToArray(cx, array_obj, (const char *) name,
|
||||
index, obj)) {
|
||||
obj = NULL;
|
||||
goto done;
|
||||
}
|
||||
|
||||
/* Put it in the index to object hash table */
|
||||
map = lm_GetIdToObjectMap(decoder);
|
||||
if (map)
|
||||
PR_HashTableAdd(map,
|
||||
LM_GET_MAPPING_KEY(LM_IMAGES, layer_id, index),
|
||||
obj);
|
||||
|
||||
/* OK, we've got our image, see if there are any event handlers
|
||||
* defined with it
|
||||
*/
|
||||
if(tag) {
|
||||
PA_Block onload = lo_FetchParamValue(context, tag, PARAM_ONLOAD);
|
||||
PA_Block onabort = lo_FetchParamValue(context, tag, PARAM_ONABORT);
|
||||
PA_Block onerror = lo_FetchParamValue(context, tag, PARAM_ONERROR);
|
||||
PA_Block onmousedown = lo_FetchParamValue(context, tag, PARAM_ONMOUSEDOWN);
|
||||
PA_Block onmouseup = lo_FetchParamValue(context, tag, PARAM_ONMOUSEUP);
|
||||
PA_Block id = lo_FetchParamValue(context, tag, PARAM_ID);
|
||||
|
||||
/* don't hold the layout lock across compiles */
|
||||
LO_UnlockLayout();
|
||||
|
||||
if (onload != NULL) {
|
||||
(void) lm_CompileEventHandler(decoder, id, tag->data,
|
||||
tag->newline_count, obj,
|
||||
PARAM_ONLOAD, onload);
|
||||
PA_FREE(onload);
|
||||
}
|
||||
|
||||
if (onabort != NULL) {
|
||||
(void) lm_CompileEventHandler(decoder, id, tag->data,
|
||||
tag->newline_count, obj,
|
||||
PARAM_ONABORT, onabort);
|
||||
PA_FREE(onabort);
|
||||
}
|
||||
|
||||
if (onerror != NULL) {
|
||||
(void) lm_CompileEventHandler(decoder, id, tag->data,
|
||||
tag->newline_count, obj,
|
||||
PARAM_ONERROR, onerror);
|
||||
PA_FREE(onerror);
|
||||
}
|
||||
if (onmousedown != NULL) {
|
||||
(void) lm_CompileEventHandler(decoder, id, tag->data,
|
||||
tag->newline_count, obj,
|
||||
PARAM_ONMOUSEDOWN, onmousedown);
|
||||
PA_FREE(onmousedown);
|
||||
}
|
||||
if (onmouseup != NULL) {
|
||||
(void) lm_CompileEventHandler(decoder, id, tag->data,
|
||||
tag->newline_count, obj,
|
||||
PARAM_ONMOUSEUP, onmouseup);
|
||||
PA_FREE(onmouseup);
|
||||
}
|
||||
|
||||
if (id)
|
||||
PA_FREE(id);
|
||||
|
||||
LO_LockLayout();
|
||||
}
|
||||
|
||||
done:
|
||||
|
||||
if(name)
|
||||
PA_FREE(name);
|
||||
LM_PutMochaDecoder(decoder);
|
||||
|
||||
return obj;
|
||||
}
|
||||
|
||||
void
|
||||
lm_ProcessImageEvent(MWContext *context, JSObject *obj,
|
||||
LM_ImageEvent event)
|
||||
{
|
||||
uint event_mask;
|
||||
jsval result;
|
||||
JSImage *image;
|
||||
|
||||
image = JS_GetPrivate(context->mocha_context, obj);
|
||||
if (!image)
|
||||
return;
|
||||
|
||||
image->pending_events |= PR_BIT(event);
|
||||
|
||||
/* Special event used to trigger deferred events */
|
||||
if (! (image->pending_events & PR_BIT(LM_IMGUNBLOCK)))
|
||||
return;
|
||||
|
||||
for (event = LM_IMGLOAD; event <= LM_LASTEVENT; event++) {
|
||||
event_mask = PR_BIT(event);
|
||||
if (image->pending_events & event_mask) {
|
||||
|
||||
JSEvent *pEvent;
|
||||
pEvent=XP_NEW_ZAP(JSEvent);
|
||||
|
||||
image->pending_events &= ~event_mask;
|
||||
switch (event) {
|
||||
case LM_IMGLOAD:
|
||||
pEvent->type = EVENT_LOAD;
|
||||
image->complete = JS_TRUE;
|
||||
break;
|
||||
case LM_IMGABORT:
|
||||
pEvent->type = EVENT_ABORT;
|
||||
image->complete = JS_TRUE;
|
||||
break;
|
||||
case LM_IMGERROR:
|
||||
pEvent->type = EVENT_ERROR;
|
||||
image->complete = JS_TRUE;
|
||||
break;
|
||||
default:
|
||||
XP_ABORT(("Unknown image event"));
|
||||
}
|
||||
|
||||
lm_SendEvent(context, obj, pEvent, &result);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
JSBool
|
||||
lm_InitImageClass(MochaDecoder *decoder)
|
||||
{
|
||||
JSContext *cx;
|
||||
JSObject *prototype;
|
||||
|
||||
cx = decoder->js_context;
|
||||
prototype = JS_InitClass(cx, decoder->window_object,
|
||||
decoder->event_receiver_prototype, &lm_image_class,
|
||||
Image, 0, image_props, NULL, NULL, NULL);
|
||||
if (!prototype)
|
||||
return JS_FALSE;
|
||||
decoder->image_prototype = prototype;
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
/* Create an image context for anonymous images and attach it to the specified
|
||||
mocha decoder. */
|
||||
JSBool
|
||||
lm_NewImageContext(MWContext *context, MochaDecoder *decoder)
|
||||
{
|
||||
IL_GroupContext *img_cx;
|
||||
IMGCB* img_cb;
|
||||
JMCException *exc = NULL;
|
||||
|
||||
if (!decoder->image_context) {
|
||||
img_cb = IMGCBFactory_Create(&exc); /* JMC Module */
|
||||
if (exc) {
|
||||
JMC_DELETE_EXCEPTION(&exc); /* XXX Should really return
|
||||
exception */
|
||||
JS_ReportOutOfMemory(decoder->js_context);
|
||||
return JS_FALSE;
|
||||
}
|
||||
|
||||
/* Create an Image Group Context. IL_NewGroupContext augments the
|
||||
reference count for the JMC callback interface. The opaque argument
|
||||
to IL_NewGroupContext is the Front End's display context, which will
|
||||
be passed back to all the Image Library's FE callbacks. */
|
||||
img_cx = IL_NewGroupContext((void*)context, (IMGCBIF *)img_cb);
|
||||
if (!img_cx) {
|
||||
JS_ReportOutOfMemory(decoder->js_context);
|
||||
return JS_FALSE;
|
||||
}
|
||||
|
||||
/* Attach the IL_GroupContext to the mocha decoder. */
|
||||
decoder->image_context = img_cx;
|
||||
|
||||
/* Allow the context to observe the decoder's image context. */
|
||||
ET_il_SetGroupObserver(context, decoder->image_context, context, JS_TRUE);
|
||||
}
|
||||
return JS_TRUE;
|
||||
}
|
||||
2007
mozilla/lib/libmocha/lm_init.c
Normal file
2007
mozilla/lib/libmocha/lm_init.c
Normal file
File diff suppressed because it is too large
Load Diff
2558
mozilla/lib/libmocha/lm_input.c
Normal file
2558
mozilla/lib/libmocha/lm_input.c
Normal file
File diff suppressed because it is too large
Load Diff
2918
mozilla/lib/libmocha/lm_layer.c
Normal file
2918
mozilla/lib/libmocha/lm_layer.c
Normal file
File diff suppressed because it is too large
Load Diff
1263
mozilla/lib/libmocha/lm_plgin.c
Normal file
1263
mozilla/lib/libmocha/lm_plgin.c
Normal file
File diff suppressed because it is too large
Load Diff
2010
mozilla/lib/libmocha/lm_taint.c
Normal file
2010
mozilla/lib/libmocha/lm_taint.c
Normal file
File diff suppressed because it is too large
Load Diff
287
mozilla/lib/libmocha/lm_trggr.c
Normal file
287
mozilla/lib/libmocha/lm_trggr.c
Normal file
@@ -0,0 +1,287 @@
|
||||
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
/*
|
||||
* lm_trggr.c
|
||||
*
|
||||
* Reflects AutoInstall trigger methods
|
||||
* into the global JavaScript config object.
|
||||
*
|
||||
* See Trigger.java for related functions.
|
||||
*/
|
||||
|
||||
#include "lm.h"
|
||||
#include "prefapi.h"
|
||||
#include "VerReg.h"
|
||||
#include "softupdt.h"
|
||||
#include "gui.h" /* XP_AppPlatform */
|
||||
|
||||
JSBool PR_CALLBACK asd_Version(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
|
||||
JSBool PR_CALLBACK asd_get_version(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
|
||||
JSBool PR_CALLBACK asd_start_update(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
|
||||
JSBool PR_CALLBACK asd_conditional_update(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
|
||||
JSBool PR_CALLBACK asd_alert(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
|
||||
JSBool PR_CALLBACK asd_platform(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval);
|
||||
|
||||
PRIVATE JSFunctionSpec autoinstall_methods[] = {
|
||||
{ "getVersion", asd_get_version, 2 },
|
||||
{ "startUpdate", asd_start_update, 2 },
|
||||
{ "conditionalUpdate", asd_conditional_update, 4 },
|
||||
{ "startUpdateComponent", asd_conditional_update, 4 }, /* old name */
|
||||
{ NULL, NULL, 0 }
|
||||
};
|
||||
|
||||
PRIVATE JSFunctionSpec globalconfig_methods[] = {
|
||||
{ "alert", asd_alert, 1 },
|
||||
{ "getPlatform", asd_platform, 0 },
|
||||
{ NULL, NULL, 0 }
|
||||
};
|
||||
|
||||
PRIVATE JSClass autoinstall_class = {
|
||||
"AutoInstall", 0,
|
||||
JS_PropertyStub, JS_PropertyStub, JS_PropertyStub, JS_PropertyStub,
|
||||
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, JS_FinalizeStub
|
||||
};
|
||||
|
||||
PRIVATE JSClass version_class = {
|
||||
"VersionInfo", 0,
|
||||
JS_PropertyStub, JS_PropertyStub, JS_PropertyStub, JS_PropertyStub,
|
||||
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, JS_FinalizeStub
|
||||
};
|
||||
|
||||
JSBool lm_DefineTriggers()
|
||||
{
|
||||
JSContext *globalContext = NULL;
|
||||
JSObject *globalObject = NULL;
|
||||
JSObject *autoInstallObject, *versionObject;
|
||||
JSBool ans;
|
||||
|
||||
/* get global mocha context and object */
|
||||
PREF_GetConfigContext(&globalContext);
|
||||
PREF_GetGlobalConfigObject(&globalObject);
|
||||
|
||||
if (globalContext == NULL || globalObject == NULL) {
|
||||
return JS_FALSE;
|
||||
}
|
||||
|
||||
JS_BeginRequest(globalContext);
|
||||
/* define AutoInstall object in global object */
|
||||
autoInstallObject = JS_DefineObject(globalContext, globalObject,
|
||||
"AutoInstall",
|
||||
&autoinstall_class,
|
||||
NULL,
|
||||
JSPROP_ENUMERATE|JSPROP_READONLY);
|
||||
|
||||
if (!autoInstallObject) {
|
||||
JS_EndRequest(globalContext);
|
||||
return JS_FALSE;
|
||||
}
|
||||
|
||||
|
||||
/* define Version class in AutoInstall */
|
||||
versionObject = JS_InitClass(globalContext, autoInstallObject, NULL,
|
||||
&version_class, asd_Version, 0, NULL, NULL, NULL, NULL);
|
||||
|
||||
if (!versionObject) {
|
||||
JS_EndRequest(globalContext);
|
||||
return JS_FALSE;
|
||||
}
|
||||
|
||||
/* define some global config utility functions */
|
||||
JS_DefineFunctions(globalContext, globalObject, globalconfig_methods);
|
||||
|
||||
ans = JS_DefineFunctions(globalContext, autoInstallObject,
|
||||
autoinstall_methods);
|
||||
JS_EndRequest(globalContext);
|
||||
return ans;
|
||||
}
|
||||
|
||||
/* Convert VERSION type to Version JS object */
|
||||
static void asd_versToObj(JSContext *cx, VERSION* vers, JSObject* versObj)
|
||||
{
|
||||
jsval val = INT_TO_JSVAL(vers->major);
|
||||
JS_SetProperty(cx, versObj, "major", &val);
|
||||
val = INT_TO_JSVAL(vers->minor);
|
||||
JS_SetProperty(cx, versObj, "minor", &val);
|
||||
val = INT_TO_JSVAL(vers->release);
|
||||
JS_SetProperty(cx, versObj, "release", &val);
|
||||
val = INT_TO_JSVAL(vers->build);
|
||||
JS_SetProperty(cx, versObj, "build", &val);
|
||||
}
|
||||
|
||||
/* Convert Version JS object to VERSION type */
|
||||
static void asd_objToVers(JSContext *cx, JSObject* versObj, VERSION* vers)
|
||||
{
|
||||
jsval val;
|
||||
JS_GetProperty(cx, versObj, "major", &val);
|
||||
vers->major = JSVAL_TO_INT(val);
|
||||
JS_GetProperty(cx, versObj, "minor", &val);
|
||||
vers->minor = JSVAL_TO_INT(val);
|
||||
JS_GetProperty(cx, versObj, "release", &val);
|
||||
vers->release = JSVAL_TO_INT(val);
|
||||
JS_GetProperty(cx, versObj, "build", &val);
|
||||
vers->build = JSVAL_TO_INT(val);
|
||||
}
|
||||
|
||||
/*
|
||||
* ?? -- move this to VR?
|
||||
* Returns 0 if versions are equal; < 0 if vers2 is newer; > 0 if vers1 is newer
|
||||
*/
|
||||
static int asd_compareVersion(VERSION* vers1, VERSION* vers2)
|
||||
{
|
||||
int diff;
|
||||
if (vers1 == NULL)
|
||||
diff = -4;
|
||||
else if (vers2 == NULL)
|
||||
diff = 4;
|
||||
else if (vers1->major == vers2->major) {
|
||||
if (vers1->minor == vers2->minor) {
|
||||
if (vers1->release == vers2->release) {
|
||||
if (vers1->build == vers2->build)
|
||||
diff = 0;
|
||||
else diff = (vers1->build > vers2->build) ? 1 : -1;
|
||||
}
|
||||
else diff = (vers1->release > vers2->release) ? 2 : -2;
|
||||
}
|
||||
else diff = (vers1->minor > vers2->minor) ? 3 : -3;
|
||||
}
|
||||
else diff = (vers1->major > vers2->major) ? 4 : -4;
|
||||
return diff;
|
||||
}
|
||||
|
||||
/* Version constructor
|
||||
(accepts up to four int params to initialize fields) */
|
||||
JSBool PR_CALLBACK asd_Version
|
||||
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
|
||||
{
|
||||
VERSION vers;
|
||||
vers.major = (argc >= 1 && JSVAL_IS_INT(argv[0])) ? JSVAL_TO_INT(argv[0]) : 0;
|
||||
vers.minor = (argc >= 2 && JSVAL_IS_INT(argv[1])) ? JSVAL_TO_INT(argv[1]) : 0;
|
||||
vers.release = (argc >= 3 && JSVAL_IS_INT(argv[2])) ? JSVAL_TO_INT(argv[2]) : 0;
|
||||
vers.build = (argc >= 4 && JSVAL_IS_INT(argv[3])) ? JSVAL_TO_INT(argv[3]) : 0;
|
||||
|
||||
asd_versToObj(cx, &vers, obj);
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
/* arguments:
|
||||
0. component name
|
||||
1. version no. to fill in
|
||||
return:
|
||||
error status */
|
||||
JSBool PR_CALLBACK asd_get_version
|
||||
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
|
||||
{
|
||||
REGERR status = 0;
|
||||
if (argc >= 2 && JSVAL_IS_STRING(argv[0])
|
||||
&& JSVAL_IS_OBJECT(argv[1]))
|
||||
{
|
||||
VERSION vers;
|
||||
char* component_path = JS_GetStringBytes(JSVAL_TO_STRING(argv[0]));
|
||||
status = VR_GetVersion(component_path, &vers);
|
||||
|
||||
if (status == REGERR_OK) {
|
||||
JSObject* versObj = JSVAL_TO_OBJECT(argv[1]);
|
||||
asd_versToObj(cx, &vers, versObj);
|
||||
}
|
||||
}
|
||||
*rval = INT_TO_JSVAL(status);
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
/* arguments:
|
||||
0. url
|
||||
1. flags
|
||||
return:
|
||||
true if no errors */
|
||||
JSBool PR_CALLBACK asd_start_update
|
||||
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
|
||||
{
|
||||
if (argc >= 2 && JSVAL_IS_STRING(argv[0]) &&
|
||||
JSVAL_IS_INT(argv[1])) {
|
||||
char* url = JS_GetStringBytes(JSVAL_TO_STRING(argv[0]));
|
||||
/* Bookmarks is a hack, you should really get some SmartUpdate context */
|
||||
MWContext* cx = XP_FindContextOfType(NULL, MWContextBookmarks);
|
||||
|
||||
XP_Bool result = SU_StartSoftwareUpdate( cx, url,
|
||||
NULL, NULL, NULL, JSVAL_TO_INT(argv[1]) );
|
||||
*rval = BOOLEAN_TO_JSVAL(result);
|
||||
return JS_TRUE;
|
||||
}
|
||||
*rval = BOOLEAN_TO_JSVAL(JS_FALSE);
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
/* arguments:
|
||||
0. url
|
||||
1. component name
|
||||
2. version no. to compare
|
||||
3. flags
|
||||
return:
|
||||
true if update triggered and no errors */
|
||||
JSBool PR_CALLBACK asd_conditional_update
|
||||
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
|
||||
{
|
||||
REGERR status = 0;
|
||||
if (argc >= 4 && JSVAL_IS_STRING(argv[0]) &&
|
||||
JSVAL_IS_STRING(argv[1]) &&
|
||||
JSVAL_IS_OBJECT(argv[2]) &&
|
||||
JSVAL_IS_INT(argv[3]))
|
||||
{
|
||||
VERSION curr_vers;
|
||||
char* component_path = JS_GetStringBytes(JSVAL_TO_STRING(argv[1]));
|
||||
status = VR_GetVersion(component_path, &curr_vers);
|
||||
|
||||
if (status == REGERR_OK) {
|
||||
JSObject* versObj = JSVAL_TO_OBJECT(argv[2]);
|
||||
VERSION req_vers;
|
||||
asd_objToVers(cx, versObj, &req_vers);
|
||||
if ( asd_compareVersion(&req_vers, &curr_vers) > 0 ) {
|
||||
char* url = JS_GetStringBytes(JSVAL_TO_STRING(argv[0]));
|
||||
MWContext* cx = XP_FindContextOfType(NULL, MWContextBookmarks);
|
||||
|
||||
XP_Bool result = SU_StartSoftwareUpdate( cx, url,
|
||||
NULL, NULL, NULL, JSVAL_TO_INT(argv[3]) );
|
||||
*rval = BOOLEAN_TO_JSVAL(result);
|
||||
return JS_TRUE;
|
||||
}
|
||||
}
|
||||
}
|
||||
*rval = BOOLEAN_TO_JSVAL(JS_FALSE); /*INT_TO_JSVAL(status);*/
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
JSBool PR_CALLBACK asd_alert
|
||||
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
|
||||
{
|
||||
if (argc >= 1 && JSVAL_IS_STRING(argv[0])) {
|
||||
char* msg = JS_GetStringBytes(JSVAL_TO_STRING(argv[0]));
|
||||
MWContext* ctx = XP_FindSomeContext();
|
||||
|
||||
if (ctx)
|
||||
FE_Alert(ctx, msg);
|
||||
}
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
JSBool PR_CALLBACK asd_platform
|
||||
(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval *rval)
|
||||
{
|
||||
*rval = STRING_TO_JSVAL( JS_NewStringCopyZ(cx, XP_AppPlatform) );
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
3571
mozilla/lib/libmocha/lm_win.c
Normal file
3571
mozilla/lib/libmocha/lm_win.c
Normal file
File diff suppressed because it is too large
Load Diff
425
mozilla/lib/libmocha/lm_wngrp.c
Normal file
425
mozilla/lib/libmocha/lm_wngrp.c
Normal file
@@ -0,0 +1,425 @@
|
||||
/*
|
||||
* lm_wngrp.c: Structures and functions to deal with new LM window groups
|
||||
* and multiple LM threads and what not.
|
||||
*
|
||||
* All blame to Mike McCool (mlm@netscape.com) 2/17/98
|
||||
*/
|
||||
|
||||
#include "lm.h"
|
||||
#include "xp.h"
|
||||
#include "prclist.h"
|
||||
#include "prthread.h"
|
||||
#include "prmon.h"
|
||||
|
||||
#ifdef XP_MAC
|
||||
#include "pprthred.h" /* for PR_CreateThreadGCAble */
|
||||
#else
|
||||
#include "private/pprthred.h"
|
||||
#endif
|
||||
|
||||
/*
|
||||
* Notes to self
|
||||
*
|
||||
* - lm_window_count: do we care that there's only one?
|
||||
* - do we need to add a limit to number of threads we spawn()?
|
||||
* - JRIEnv: do we need multiple?
|
||||
* - JSRuntime: do we need multiple?
|
||||
* - Threading changes: impact on debugger?
|
||||
* - JS_SetGlobalObject(JSContext) will be important
|
||||
* - If the global structure is on the mozilla thread, can other threads
|
||||
* creating a new thread group access, or do I have to post an event?
|
||||
*
|
||||
* ? Rename "MochaDecoder" to "LMWindow"
|
||||
* ? Change so that there is only one JSContext
|
||||
*/
|
||||
|
||||
PRMonitor *wingroups_mon;
|
||||
LMWindowGroup *wingroups;
|
||||
PRMonitor *request_mon;
|
||||
|
||||
struct ContextListStr {
|
||||
ContextList *next;
|
||||
ContextList *prev;
|
||||
MWContext *context;
|
||||
};
|
||||
|
||||
LMWindowGroup *_lm_NewWindowGroup(int priority);
|
||||
|
||||
/* Initialize my globals, from the Mozilla thread
|
||||
*/
|
||||
void lm_InitWindowGroups(void)
|
||||
{
|
||||
int priority;
|
||||
|
||||
/* run at slightly lower priority than the mozilla thread */
|
||||
priority = PR_GetThreadPriority(PR_CurrentThread());
|
||||
PR_ASSERT(priority >= PR_PRIORITY_FIRST && priority <= PR_PRIORITY_LAST);
|
||||
|
||||
if (priority == PR_PRIORITY_NORMAL)
|
||||
priority = PR_PRIORITY_LOW;
|
||||
else if (priority == PR_PRIORITY_HIGH)
|
||||
priority = PR_PRIORITY_NORMAL;
|
||||
else if (priority == PR_PRIORITY_URGENT)
|
||||
priority = PR_PRIORITY_HIGH;
|
||||
else
|
||||
priority = PR_PRIORITY_LOW;
|
||||
|
||||
wingroups_mon = PR_NewMonitor();
|
||||
request_mon = PR_NewMonitor();
|
||||
wingroups = NULL;
|
||||
wingroups = _lm_NewWindowGroup(priority);
|
||||
if(wingroups != NULL) {
|
||||
PR_INIT_CLIST(wingroups);
|
||||
lm_StartWindowGroup(wingroups);
|
||||
} /* else huh?! */
|
||||
}
|
||||
|
||||
/* Create a new window group. Create new context, create new monitor, create
|
||||
* new thread, event queue, queue stack, empty context list.
|
||||
*/
|
||||
LMWindowGroup *lm_NewWindowGroup(void)
|
||||
{
|
||||
int priority;
|
||||
|
||||
/* Run at same priority as current thread (which should be a JS
|
||||
* thread.
|
||||
*/
|
||||
priority = PR_GetThreadPriority(PR_CurrentThread());
|
||||
PR_ASSERT(priority>=PR_PRIORITY_FIRST && priority<=PR_PRIORITY_LAST);
|
||||
return _lm_NewWindowGroup(priority);
|
||||
}
|
||||
|
||||
LMWindowGroup *_lm_NewWindowGroup(int priority)
|
||||
{
|
||||
LMWindowGroup *newgrp = XP_NEW_ZAP(LMWindowGroup);
|
||||
if(newgrp != NULL) {
|
||||
newgrp->done = PR_FALSE;
|
||||
newgrp->hasLock = PR_FALSE;
|
||||
|
||||
/* Create a new JS Context for this set of windows.
|
||||
* Note: Need to get global runtime lm_runtime from somewhere,
|
||||
* and perhaps the LM_STACK_SIZE?
|
||||
*/
|
||||
/**************************************************** MLM *
|
||||
newgrp->js_context = JS_NewContext(lm_runtime, LM_STACK_SIZE);
|
||||
if(newgrp->js_context == NULL) {
|
||||
XP_DELETE(newgrp);
|
||||
return NULL;
|
||||
}
|
||||
**************************************************** MLM */
|
||||
newgrp->js_context = NULL;
|
||||
/* JS_SetGCCallback(newgrp->js_context, LM_ShouldRunGC); */
|
||||
|
||||
newgrp->mw_contexts = XP_NEW_ZAP(ContextList);
|
||||
if(newgrp->mw_contexts == NULL) {
|
||||
JS_DestroyContext(newgrp->js_context);
|
||||
XP_DELETE(newgrp);
|
||||
return NULL;
|
||||
}
|
||||
PR_INIT_CLIST(newgrp->mw_contexts);
|
||||
newgrp->mw_contexts->context = NULL;
|
||||
newgrp->current_context = NULL;
|
||||
|
||||
newgrp->queue_stack = XP_NEW_ZAP(QueueStackElement);
|
||||
if(!newgrp->queue_stack) {
|
||||
JS_DestroyContext(newgrp->js_context);
|
||||
XP_DELETE(newgrp->mw_contexts);
|
||||
XP_DELETE(newgrp);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/* Do this here so we don't race ourselves in lm_wait_for_events */
|
||||
PR_EnterMonitor(wingroups_mon);
|
||||
if(wingroups != NULL) {
|
||||
PR_APPEND_LINK(newgrp, wingroups);
|
||||
}
|
||||
PR_ExitMonitor(wingroups_mon);
|
||||
|
||||
newgrp->waiting_list = NULL;
|
||||
|
||||
newgrp->owner_monitor = PR_NewMonitor();
|
||||
newgrp->queue_monitor = PR_NewMonitor();
|
||||
|
||||
PR_EnterMonitor(newgrp->owner_monitor);
|
||||
newgrp->thread = PR_CreateThreadGCAble(PR_USER_THREAD,
|
||||
lm_wait_for_events, newgrp,
|
||||
priority, PR_LOCAL_THREAD,
|
||||
PR_UNJOINABLE_THREAD, 0);
|
||||
newgrp->owner = newgrp->thread;
|
||||
newgrp->current_count = 0;
|
||||
newgrp->mozWantsLock = PR_FALSE;
|
||||
newgrp->mozGotLock = PR_FALSE;
|
||||
newgrp->interruptCurrentOp = PR_FALSE;
|
||||
newgrp->queue_depth = 0;
|
||||
newgrp->queue_count = 0;
|
||||
|
||||
/* Note: Need a unique identifier for this queue?
|
||||
*/
|
||||
newgrp->interpret_queue = PR_CreateEventQueue("new_event_queue",
|
||||
newgrp->thread);
|
||||
newgrp->queue_stack->queue = newgrp->interpret_queue;
|
||||
|
||||
newgrp->lock_context = NULL;
|
||||
newgrp->js_timeout_insertion_point = NULL;
|
||||
newgrp->js_timeout_running = NULL;
|
||||
newgrp->inputRecurring = 0;
|
||||
}
|
||||
return newgrp;
|
||||
}
|
||||
|
||||
void lm_StartWindowGroup(LMWindowGroup *grp)
|
||||
{
|
||||
PR_Notify(grp->owner_monitor);
|
||||
PR_ExitMonitor(grp->owner_monitor);
|
||||
}
|
||||
|
||||
void lm_DestroyWindowGroup(LMWindowGroup *grp)
|
||||
{
|
||||
PR_EnterMonitor(wingroups_mon);
|
||||
/* Note: Thread terminates when the thread's main function (in
|
||||
* this case, lm_wait_for_events) exits.
|
||||
*/
|
||||
/************************************ MLM *
|
||||
* JS_DestroyContext(grp->js_context);
|
||||
************************************ MLM */
|
||||
PR_DestroyMonitor(grp->owner_monitor);
|
||||
PR_DestroyMonitor(grp->queue_monitor);
|
||||
|
||||
/* Note: How to destroy an event queue or two?
|
||||
*/
|
||||
|
||||
/* Note: Context list should already be null
|
||||
*/
|
||||
|
||||
PR_REMOVE_LINK(grp);
|
||||
XP_DELETE(grp);
|
||||
PR_ExitMonitor(wingroups_mon);
|
||||
}
|
||||
|
||||
LMWindowGroup *LM_GetDefaultWindowGroup(MWContext *mwc)
|
||||
{
|
||||
LMWindowGroup *ans;
|
||||
|
||||
/* Check to see if this is a frame context. If so, check its parent. */
|
||||
if((mwc != NULL) && (mwc->is_grid_cell)) {
|
||||
MWContext *grid_parent, *grid_child;
|
||||
grid_child = mwc;
|
||||
grid_parent = mwc->grid_parent;
|
||||
/* Find the root parent. I wonder if I need to add cycle checking. */
|
||||
while(grid_parent != NULL) {
|
||||
grid_child = grid_parent;
|
||||
grid_parent = grid_child->grid_parent;
|
||||
}
|
||||
if( (ans = lm_MWContextToGroup(grid_child)) != NULL) {
|
||||
/* The parent's been found, return its group. */
|
||||
return ans;
|
||||
} else { /* Else add the parent to the default group,
|
||||
* and return that. */
|
||||
PR_EnterMonitor(wingroups_mon);
|
||||
LM_AddContextToGroup(wingroups, grid_child);
|
||||
ans = wingroups;
|
||||
PR_ExitMonitor(wingroups_mon);
|
||||
return ans;
|
||||
}
|
||||
}
|
||||
PR_EnterMonitor(wingroups_mon);
|
||||
ans = wingroups;
|
||||
PR_ExitMonitor(wingroups_mon);
|
||||
return ans;
|
||||
}
|
||||
|
||||
LMWindowGroup *lm_MWContextToGroup(MWContext *mwc)
|
||||
{
|
||||
LMWindowGroup *ptr = NULL;
|
||||
LMWindowGroup *ans = NULL;
|
||||
|
||||
PR_EnterMonitor(wingroups_mon);
|
||||
|
||||
ptr = wingroups;
|
||||
|
||||
if(lm_GetEntryForContext(wingroups, mwc) != NULL) {
|
||||
ans = wingroups;
|
||||
PR_ExitMonitor(wingroups_mon);
|
||||
return ans;
|
||||
}
|
||||
|
||||
ptr = PR_NEXT_LINK(ptr);
|
||||
while(ptr != wingroups) {
|
||||
if(lm_GetEntryForContext(ptr, mwc) != NULL) {
|
||||
ans = ptr;
|
||||
PR_ExitMonitor(wingroups_mon);
|
||||
return ans;
|
||||
}
|
||||
ptr = PR_NEXT_LINK(ptr);
|
||||
}
|
||||
PR_ExitMonitor(wingroups_mon);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
LMWindowGroup *lm_QueueStackToGroup(QueueStackElement *qse)
|
||||
{
|
||||
LMWindowGroup *ptr = NULL;
|
||||
LMWindowGroup *ans = NULL;
|
||||
|
||||
PR_EnterMonitor(wingroups_mon);
|
||||
ptr = wingroups;
|
||||
|
||||
if(wingroups->queue_stack == qse) {
|
||||
ans = wingroups;
|
||||
PR_ExitMonitor(wingroups_mon);
|
||||
return ans;
|
||||
}
|
||||
|
||||
ptr = PR_NEXT_LINK(ptr);
|
||||
while(ptr != wingroups) {
|
||||
if(ptr->queue_stack == qse) {
|
||||
ans = ptr;
|
||||
PR_ExitMonitor(wingroups_mon);
|
||||
return ans;
|
||||
}
|
||||
ptr = PR_NEXT_LINK(ptr);
|
||||
}
|
||||
PR_ExitMonitor(wingroups_mon);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
PREventQueue *LM_MWContextToQueue(MWContext *mwc)
|
||||
{
|
||||
/* Note: This gets the interpret queue, need to get top queue as well
|
||||
*/
|
||||
LMWindowGroup *grp = lm_MWContextToGroup(mwc);
|
||||
if(grp != NULL) {
|
||||
return LM_WindowGroupToQueue(grp);
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
PREventQueue *LM_WindowGroupToQueue(LMWindowGroup *lmg)
|
||||
{
|
||||
return lmg->interpret_queue;
|
||||
}
|
||||
|
||||
ContextList *lm_GetEntryForContext(LMWindowGroup *grp, MWContext *cx)
|
||||
{
|
||||
ContextList *cxl = grp->mw_contexts;
|
||||
ContextList *ans = NULL;
|
||||
|
||||
if(PR_CLIST_IS_EMPTY(cxl)) {
|
||||
return NULL;
|
||||
} else {
|
||||
ContextList *ptr = PR_NEXT_LINK(cxl);
|
||||
while(ptr != cxl) {
|
||||
if(ptr->context == cx) {
|
||||
ans = ptr;
|
||||
break;
|
||||
}
|
||||
ptr = PR_NEXT_LINK(ptr);
|
||||
}
|
||||
}
|
||||
return ans;
|
||||
}
|
||||
|
||||
void LM_AddContextToGroup(LMWindowGroup *grp, MWContext *cx)
|
||||
{
|
||||
ContextList *cxl;
|
||||
|
||||
if(lm_MWContextToGroup(cx) != NULL) {
|
||||
/* Hey, why are we adding this stuff twice? */
|
||||
XP_ASSERT(0);
|
||||
}
|
||||
|
||||
cxl = XP_NEW_ZAP(ContextList);
|
||||
/* Note: failure?!?!?!
|
||||
*/
|
||||
cxl->context = cx;
|
||||
|
||||
PR_APPEND_LINK(cxl, grp->mw_contexts);
|
||||
}
|
||||
|
||||
void lm_RemoveContextFromGroup(LMWindowGroup *grp, MWContext *cx);
|
||||
|
||||
void LM_RemoveContextFromGroup(MWContext *cx)
|
||||
{
|
||||
LMWindowGroup *grp = lm_MWContextToGroup(cx);
|
||||
if(grp) {
|
||||
lm_RemoveContextFromGroup(grp, cx);
|
||||
}
|
||||
}
|
||||
|
||||
void lm_RemoveContextFromGroup(LMWindowGroup *grp, MWContext *cx)
|
||||
{
|
||||
if(!PR_CLIST_IS_EMPTY(grp->mw_contexts)) {
|
||||
ContextList *entry = lm_GetEntryForContext(grp, cx);
|
||||
if(entry != NULL) {
|
||||
PR_REMOVE_LINK(entry);
|
||||
XP_DELETE(entry);
|
||||
}
|
||||
}
|
||||
if(PR_CLIST_IS_EMPTY(grp->mw_contexts) && (grp != wingroups)) {
|
||||
grp->done = PR_TRUE;
|
||||
}
|
||||
}
|
||||
|
||||
PRBool LM_IsLocked(LMWindowGroup *grp)
|
||||
{
|
||||
PRBool ans;
|
||||
PR_EnterMonitor(request_mon);
|
||||
ans = grp->hasLock;
|
||||
PR_ExitMonitor(request_mon);
|
||||
return ans;
|
||||
}
|
||||
|
||||
void LM_BeginRequest(LMWindowGroup *grp, JSContext *jsc)
|
||||
{
|
||||
PR_EnterMonitor(request_mon);
|
||||
grp->hasLock = PR_TRUE;
|
||||
grp->lock_context = jsc;
|
||||
if((JS_GetContextThread(jsc)) != ((intN) grp->thread)) {
|
||||
JS_SetContextThread(jsc);
|
||||
}
|
||||
PR_ExitMonitor(request_mon);
|
||||
JS_BeginRequest(jsc);
|
||||
}
|
||||
|
||||
void LM_EndRequest(LMWindowGroup *grp, JSContext *jsc)
|
||||
{
|
||||
JS_EndRequest(jsc);
|
||||
PR_EnterMonitor(request_mon);
|
||||
grp->lock_context = NULL;
|
||||
grp->hasLock = PR_FALSE;
|
||||
PR_ExitMonitor(request_mon);
|
||||
}
|
||||
|
||||
JSBool LM_ShouldRunGC(JSContext *cx, JSGCStatus status)
|
||||
{
|
||||
JSBool ans = JS_TRUE;
|
||||
JSContext *active;
|
||||
LMWindowGroup *ptr;
|
||||
|
||||
if(status != JSGC_BEGIN) {
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
PR_EnterMonitor(request_mon);
|
||||
if(wingroups->hasLock) {
|
||||
active = wingroups->lock_context;
|
||||
if(active != cx) {
|
||||
ans=JS_FALSE;
|
||||
goto bye;
|
||||
}
|
||||
}
|
||||
ptr = PR_NEXT_LINK(wingroups);
|
||||
while(ptr != wingroups) {
|
||||
if(ptr->hasLock) {
|
||||
active = ptr->lock_context;
|
||||
if(active != cx) {
|
||||
ans=JS_FALSE;
|
||||
goto bye;
|
||||
}
|
||||
}
|
||||
ptr = PR_NEXT_LINK(ptr);
|
||||
}
|
||||
bye:
|
||||
PR_ExitMonitor(request_mon);
|
||||
return ans;
|
||||
}
|
||||
617
mozilla/lib/libnet/jscookie.c
Normal file
617
mozilla/lib/libnet/jscookie.c
Normal file
@@ -0,0 +1,617 @@
|
||||
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
/*
|
||||
jscookie.c -- javascript reflection of cookies for filters.
|
||||
Created: Frederick G.M. Roeber <roeber@netscape.com>, 12-Jul-97.
|
||||
Adopted: Judson Valeski, 1997.
|
||||
Large chunks of this were stolen from jsmsg.c.
|
||||
*/
|
||||
|
||||
#include "mkutils.h"
|
||||
#include "mkutils.h"
|
||||
#include "mkparse.h"
|
||||
#include "mkaccess.h"
|
||||
#include "prefapi.h"
|
||||
#include "jsapi.h"
|
||||
#include "xp_core.h"
|
||||
#include "xp_mcom.h"
|
||||
#include "jscookie.h"
|
||||
#include "ds.h"
|
||||
#include "htmldlgs.h"
|
||||
#include "xpgetstr.h"
|
||||
|
||||
extern int MK_ACCESS_JAVASCRIPT_COOKIE_FILTER;
|
||||
|
||||
static JSObject *filter_obj = NULL;
|
||||
static JSContext *filter_context = NULL;
|
||||
|
||||
static JSBool error_reporter_installed = JS_FALSE;
|
||||
static JSErrorReporter previous_error_reporter;
|
||||
|
||||
/* tells us when we should recompile the file. */
|
||||
static JSBool need_compile = JS_TRUE;
|
||||
|
||||
/* This is the private instance data associated with a cookie */
|
||||
typedef struct JSCookieData {
|
||||
JSContext *js_context;
|
||||
JSObject *js_object;
|
||||
JSCFCookieData *data;
|
||||
PRPackedBool property_changed, rejected, accepted, ask, decision_made;
|
||||
} JSCookieData;
|
||||
|
||||
/* The properties of a cookie that we reflect */
|
||||
enum cookie_slot {
|
||||
COOKIE_PATH = -1,
|
||||
COOKIE_DOMAIN = -2,
|
||||
COOKIE_NAME = -3,
|
||||
COOKIE_VALUE = -4,
|
||||
COOKIE_EXPIRES = -5,
|
||||
COOKIE_URL = -6,
|
||||
COOKIE_IS_SECURE = -7,
|
||||
COOKIE_IS_DOMAIN = -8,
|
||||
COOKIE_PROMPT_PREF = -9,
|
||||
COOKIE_PREF = -10
|
||||
};
|
||||
|
||||
/*
|
||||
* Should more of these be readonly? What does it mean for a cookie
|
||||
* to de secure? -chouck
|
||||
*/
|
||||
static JSPropertySpec cookie_props[] = {
|
||||
{ "path", COOKIE_PATH, JSPROP_ENUMERATE },
|
||||
{ "domain", COOKIE_DOMAIN, JSPROP_ENUMERATE },
|
||||
{ "name", COOKIE_NAME, JSPROP_ENUMERATE },
|
||||
{ "value", COOKIE_VALUE, JSPROP_ENUMERATE },
|
||||
{ "expires", COOKIE_EXPIRES, JSPROP_ENUMERATE },
|
||||
{ "url", COOKIE_URL, JSPROP_ENUMERATE|JSPROP_READONLY },
|
||||
{ "isSecure", COOKIE_IS_SECURE, JSPROP_ENUMERATE },
|
||||
{ "isDomain", COOKIE_IS_DOMAIN, JSPROP_ENUMERATE },
|
||||
{ "prompt", COOKIE_PROMPT_PREF, JSPROP_ENUMERATE|JSPROP_READONLY },
|
||||
{ "preference", COOKIE_PREF, JSPROP_ENUMERATE|JSPROP_READONLY },
|
||||
{ 0 }
|
||||
};
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
cookie_getProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
|
||||
{
|
||||
JSCookieData *data;
|
||||
JSString *str;
|
||||
jsint slot;
|
||||
|
||||
data = (JSCookieData *)JS_GetPrivate(cx, obj);
|
||||
if (!data)
|
||||
return JS_TRUE;
|
||||
|
||||
if (!JSVAL_IS_INT(id))
|
||||
return JS_TRUE;
|
||||
|
||||
slot = JSVAL_TO_INT(id);
|
||||
|
||||
switch (slot) {
|
||||
case COOKIE_PATH:
|
||||
str = JS_NewStringCopyZ(cx, (const char *)data->data->path_from_header);
|
||||
if( (JSString *)0 == str )
|
||||
return JS_FALSE;
|
||||
*vp = STRING_TO_JSVAL(str);
|
||||
break;
|
||||
case COOKIE_DOMAIN:
|
||||
str = JS_NewStringCopyZ(cx, (const char *)data->data->host_from_header);
|
||||
if( (JSString *)0 == str )
|
||||
return JS_FALSE;
|
||||
*vp = STRING_TO_JSVAL(str);
|
||||
break;
|
||||
case COOKIE_NAME:
|
||||
str = JS_NewStringCopyZ(cx, (const char *)data->data->name_from_header);
|
||||
if( (JSString *)0 == str )
|
||||
return JS_FALSE;
|
||||
*vp = STRING_TO_JSVAL(str);
|
||||
break;
|
||||
case COOKIE_VALUE:
|
||||
str = JS_NewStringCopyZ(cx, (const char *)data->data->cookie_from_header);
|
||||
if( (JSString *)0 == str )
|
||||
return JS_FALSE;
|
||||
*vp = STRING_TO_JSVAL(str);
|
||||
break;
|
||||
case COOKIE_EXPIRES:
|
||||
*vp = INT_TO_JSVAL(data->data->expires);
|
||||
break;
|
||||
case COOKIE_URL:
|
||||
str = JS_NewStringCopyZ(cx, (const char *)data->data->url);
|
||||
if( (JSString *)0 == str )
|
||||
return JS_FALSE;
|
||||
*vp = STRING_TO_JSVAL(str);
|
||||
break;
|
||||
case COOKIE_IS_SECURE:
|
||||
*vp = BOOLEAN_TO_JSVAL(data->data->secure);
|
||||
break;
|
||||
case COOKIE_IS_DOMAIN:
|
||||
*vp = BOOLEAN_TO_JSVAL(data->data->domain);
|
||||
break;
|
||||
case COOKIE_PROMPT_PREF:
|
||||
*vp = BOOLEAN_TO_JSVAL(data->data->prompt);
|
||||
break;
|
||||
case COOKIE_PREF:
|
||||
*vp = INT_TO_JSVAL(data->data->preference);
|
||||
break;
|
||||
}
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
cookie_setProperty(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
|
||||
{
|
||||
JSCookieData *data;
|
||||
jsint slot;
|
||||
PRInt32 i;
|
||||
JSBool b;
|
||||
|
||||
data = (JSCookieData *)JS_GetPrivate(cx, obj);
|
||||
if (!data)
|
||||
return JS_TRUE;
|
||||
|
||||
if (!JSVAL_IS_INT(id))
|
||||
return JS_TRUE;
|
||||
|
||||
slot = JSVAL_TO_INT(id);
|
||||
|
||||
if (slot == COOKIE_PATH) {
|
||||
data->data->path_from_header = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
|
||||
}
|
||||
else if (slot == COOKIE_DOMAIN) {
|
||||
data->data->host_from_header = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
|
||||
}
|
||||
else if (slot == COOKIE_NAME) {
|
||||
data->data->name_from_header = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
|
||||
}
|
||||
else if (slot == COOKIE_VALUE) {
|
||||
data->data->cookie_from_header = JS_GetStringBytes(JSVAL_TO_STRING(*vp));
|
||||
}
|
||||
else if (slot == COOKIE_EXPIRES) {
|
||||
if( !JS_ValueToInt32(cx, *vp, (long *)&i) )
|
||||
return JS_FALSE;
|
||||
data->data->expires = i;
|
||||
}
|
||||
else if (slot == COOKIE_IS_SECURE) {
|
||||
if( !JS_ValueToBoolean(cx, *vp, &b) )
|
||||
return JS_FALSE;
|
||||
data->data->secure = b;
|
||||
}
|
||||
else if (slot == COOKIE_IS_DOMAIN) {
|
||||
if( !JS_ValueToBoolean(cx, *vp, &b) )
|
||||
return JS_FALSE;
|
||||
data->data->domain = b;
|
||||
}
|
||||
|
||||
data->property_changed = TRUE;
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(void)
|
||||
cookie_finalize(JSContext *cx, JSObject *obj)
|
||||
{
|
||||
JSCookieData *cookie;
|
||||
cookie = JS_GetPrivate(cx, obj);
|
||||
FREEIF(cookie);
|
||||
}
|
||||
|
||||
/* So we can possibly add functions "global" to filters... */
|
||||
static JSClass global_class = {
|
||||
"CookieFilters", 0 /* no private data */,
|
||||
JS_PropertyStub, JS_PropertyStub, JS_PropertyStub, JS_PropertyStub,
|
||||
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, JS_FinalizeStub
|
||||
};
|
||||
|
||||
static JSClass js_cookie_class = {
|
||||
"Cookie", JSCLASS_HAS_PRIVATE,
|
||||
JS_PropertyStub, JS_PropertyStub, cookie_getProperty, cookie_setProperty,
|
||||
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, cookie_finalize
|
||||
};
|
||||
|
||||
/* cookie.accept() -- mark it okay */
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
cookie_accept(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval * rval)
|
||||
{
|
||||
JSCookieData *data;
|
||||
|
||||
if (!(data = (JSCookieData*)JS_GetInstancePrivate(cx, obj, &js_cookie_class, argv)))
|
||||
return JS_FALSE;
|
||||
|
||||
data->accepted = TRUE;
|
||||
data->rejected = FALSE;
|
||||
data->ask = FALSE;
|
||||
data->decision_made = TRUE;
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
/* cookie.reject() -- reject it out of hand */
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
cookie_reject(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval * rval)
|
||||
{
|
||||
JSCookieData *data;
|
||||
|
||||
if (!(data = (JSCookieData*)JS_GetInstancePrivate(cx, obj, &js_cookie_class, argv)))
|
||||
return JS_FALSE;
|
||||
|
||||
data->accepted = FALSE;
|
||||
data->rejected = TRUE;
|
||||
data->ask = FALSE;
|
||||
data->decision_made = TRUE;
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
/* cookie.ask() -- ask the luser, even if that pref is off */
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
cookie_ask(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval * rval)
|
||||
{
|
||||
JSCookieData *data;
|
||||
|
||||
if (!(data = (JSCookieData*)JS_GetInstancePrivate(cx, obj, &js_cookie_class, argv)))
|
||||
return JS_FALSE;
|
||||
|
||||
data->accepted = FALSE;
|
||||
data->rejected = FALSE;
|
||||
data->ask = TRUE;
|
||||
data->decision_made = TRUE;
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
/* cookie.confirm() -- pop up a confirmation box */
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
cookie_confirm(JSContext *cx, JSObject *obj, uint argc, jsval *argv, jsval * rval)
|
||||
{
|
||||
JSCookieData *data;
|
||||
JSString *str;
|
||||
char *msg = (char *)0;
|
||||
Bool result;
|
||||
MWContext * context = XP_FindSomeContext();
|
||||
|
||||
if (argc < 1 || !context)
|
||||
return JS_FALSE;
|
||||
|
||||
if (!(data = (JSCookieData*)JS_GetInstancePrivate(cx, obj, &js_cookie_class, argv)))
|
||||
return JS_FALSE;
|
||||
|
||||
str = JS_ValueToString(cx, argv[0]);
|
||||
if (!str)
|
||||
return JS_FALSE;
|
||||
|
||||
StrAllocCopy(msg, XP_GetString(MK_ACCESS_JAVASCRIPT_COOKIE_FILTER));
|
||||
StrAllocCat(msg, JS_GetStringBytes(str));
|
||||
if (!msg)
|
||||
return JS_FALSE;
|
||||
|
||||
result = FE_Confirm(context, msg);
|
||||
FREEIF(msg);
|
||||
|
||||
*rval = BOOLEAN_TO_JSVAL(result);
|
||||
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
#if DEBUG
|
||||
/* trace() -- outputs spew to stderr. Actually, this (or something like it
|
||||
that perhaps outputs to the same file that the rest of the filter logging code
|
||||
writes to) would probably be very useful in the normal course of writing filters. */
|
||||
PR_STATIC_CALLBACK(JSBool)
|
||||
cookie_filter_trace(JSContext *cx, JSObject * obj, uint argc, jsval *argv, jsval * rval)
|
||||
{
|
||||
|
||||
if (argc > 0)
|
||||
{
|
||||
JSString *str;
|
||||
const char *trace_str;
|
||||
if (!(str = JS_ValueToString(cx, argv[0])))
|
||||
return JS_FALSE;
|
||||
|
||||
trace_str = JS_GetStringBytes(str);
|
||||
if (*trace_str != '\0')
|
||||
{
|
||||
fprintf (stderr, "cookie filter trace: %s\n", trace_str);
|
||||
}
|
||||
return JS_TRUE;
|
||||
}
|
||||
|
||||
return JS_FALSE;
|
||||
}
|
||||
#endif
|
||||
|
||||
static JSFunctionSpec cookie_methods[] = {
|
||||
{ "accept", cookie_accept, 0 },
|
||||
{ "reject", cookie_reject, 0 },
|
||||
{ "ask", cookie_ask, 0 },
|
||||
{ "confirm", cookie_confirm, 1 },
|
||||
{ 0 }
|
||||
};
|
||||
|
||||
static JSFunctionSpec filter_methods[] = {
|
||||
#ifdef DEBUG
|
||||
{ "trace", cookie_filter_trace, 1 },
|
||||
#endif
|
||||
{ 0 }
|
||||
};
|
||||
|
||||
PRIVATE void
|
||||
destroyJSCookieFilterStuff(void)
|
||||
{
|
||||
filter_obj = NULL;
|
||||
}
|
||||
|
||||
/*
|
||||
* This function used to take an MWContext and store it as the private data
|
||||
* of the filter object. That is a no-no since the filter_obj is going to
|
||||
* be around until the end of time but there is no guarentee that the
|
||||
* context won't get free'd out from under us. The solution is to not
|
||||
* hold onto any particular context but just call XP_FindSomeContext() or
|
||||
* some derivative of it when we need to.
|
||||
*/
|
||||
PRIVATE JSContext *
|
||||
initializeJSCookieFilterStuff()
|
||||
{
|
||||
|
||||
/* Only bother initializing once */
|
||||
if (filter_obj)
|
||||
return filter_context;
|
||||
|
||||
/* If we can't get the mozilla-thread global context just bail */
|
||||
PREF_GetConfigContext(&filter_context);
|
||||
if (!filter_context)
|
||||
return NULL;
|
||||
|
||||
JS_BeginRequest(filter_context);
|
||||
/* create our "global" object. We make the message object a child of this */
|
||||
filter_obj = JS_NewObject(filter_context, &global_class, NULL, NULL);
|
||||
|
||||
/* MLM - don't do JS_InitStandardClasses() twice */
|
||||
if (!filter_obj
|
||||
|| !JS_DefineFunctions(filter_context, filter_obj, filter_methods))
|
||||
{
|
||||
JS_EndRequest(filter_context);
|
||||
destroyJSCookieFilterStuff();
|
||||
return NULL;
|
||||
}
|
||||
|
||||
JS_EndRequest(filter_context);
|
||||
return filter_context;
|
||||
}
|
||||
|
||||
PRIVATE JSObject *
|
||||
newCookieObject(void)
|
||||
{
|
||||
JSObject *rv;
|
||||
JSCookieData *cookie_data;
|
||||
|
||||
rv = JS_DefineObject(filter_context, filter_obj,
|
||||
"cookie", &js_cookie_class,
|
||||
NULL, JSPROP_ENUMERATE);
|
||||
|
||||
if( (JSObject *)0 == rv )
|
||||
return (JSObject *)0;
|
||||
|
||||
cookie_data = XP_NEW_ZAP(JSCookieData);
|
||||
|
||||
if( (JSCookieData *)0 == cookie_data )
|
||||
return (JSObject *)0;
|
||||
|
||||
if( !JS_SetPrivate(filter_context, rv, cookie_data)
|
||||
|| !JS_DefineProperties(filter_context, rv, cookie_props)
|
||||
|| !JS_DefineFunctions(filter_context, rv, cookie_methods)) {
|
||||
return (JSObject *)0;
|
||||
}
|
||||
|
||||
return rv;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(void)
|
||||
jscookie_ErrorReporter(JSContext *cx, const char *message, JSErrorReport *report)
|
||||
{
|
||||
char *msg = NULL;
|
||||
MWContext *context;
|
||||
|
||||
context = XP_FindSomeContext();
|
||||
if(!context || !report)
|
||||
return;
|
||||
|
||||
/*XXX: i18n-ise this */
|
||||
msg = PR_sprintf_append(NULL,
|
||||
"JavaScript Cookie Filter Error:\n"
|
||||
"You will be prompted manually to accept or reject this cookie.\n"
|
||||
"Filename: %s\n"
|
||||
"Line #: %u\n"
|
||||
"%s\n"
|
||||
"%.*s\n",
|
||||
report->filename,
|
||||
report->lineno,
|
||||
report->linebuf,
|
||||
(int)(report->tokenptr - report->linebuf) + 1,
|
||||
"^"
|
||||
);
|
||||
|
||||
if (!msg)
|
||||
return;
|
||||
|
||||
FE_Alert(context, msg);
|
||||
XP_FREE(msg);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
PRIVATE JSBool
|
||||
compileJSCookieFilters(void)
|
||||
{
|
||||
static time_t m_time = 0; /* the last modification time of filters.js */
|
||||
static JSBool ret_val = JS_FALSE;
|
||||
char *filename;
|
||||
XP_File fp;
|
||||
XP_StatStruct stats;
|
||||
|
||||
if (!need_compile)
|
||||
return ret_val;
|
||||
|
||||
filename = WH_FileName("", xpJSCookieFilters);
|
||||
|
||||
XP_Trace("+Filename for script filter is %s\n", filename);
|
||||
|
||||
/* If we can't get to the file, get the hell outa dodge. */
|
||||
if(XP_Stat(filename, &stats, xpJSCookieFilters))
|
||||
return ret_val;
|
||||
|
||||
if (stats.st_mtime > m_time || need_compile)
|
||||
{
|
||||
long fileLength;
|
||||
char *buffer;
|
||||
jsval rval;
|
||||
|
||||
m_time = stats.st_mtime;
|
||||
|
||||
fileLength = stats.st_size;
|
||||
if (fileLength <= 1)
|
||||
{
|
||||
ret_val = JS_FALSE;
|
||||
return ret_val;
|
||||
}
|
||||
|
||||
if( !(fp = XP_FileOpen(filename, xpJSCookieFilters, "r")) ) {
|
||||
ret_val = JS_FALSE;
|
||||
return ret_val;
|
||||
}
|
||||
|
||||
buffer = (char*)malloc(fileLength);
|
||||
if (!buffer) {
|
||||
XP_FileClose(fp);
|
||||
ret_val = JS_FALSE;
|
||||
return ret_val;
|
||||
}
|
||||
|
||||
fileLength = XP_FileRead(buffer, fileLength, fp);
|
||||
|
||||
XP_FileClose(fp);
|
||||
|
||||
XP_Trace("+Compiling filters.js...\n");
|
||||
|
||||
ret_val = JS_EvaluateScript(filter_context, filter_obj, buffer, fileLength,
|
||||
filename, 1, &rval);
|
||||
|
||||
XP_Trace("+Done.\n");
|
||||
|
||||
XP_FREE(buffer);
|
||||
|
||||
need_compile = JS_FALSE;
|
||||
}
|
||||
|
||||
return ret_val;
|
||||
}
|
||||
|
||||
PUBLIC JSCFResult
|
||||
JSCF_Execute(
|
||||
MWContext *mwcontext,
|
||||
const char *script_name,
|
||||
JSCFCookieData *data,
|
||||
Bool *data_changed
|
||||
)
|
||||
{
|
||||
jsval result;
|
||||
jsval filter_arg; /* we will this in with the message object we create. */
|
||||
JSObject *cookie_obj;
|
||||
JSCookieData *cookie_data;
|
||||
|
||||
if (!script_name)
|
||||
return JSCF_error;
|
||||
|
||||
/* initialize the filter stuff, and bomb out early if it fails */
|
||||
if (!initializeJSCookieFilterStuff())
|
||||
return JSCF_error;
|
||||
|
||||
JS_BeginRequest(filter_context);
|
||||
|
||||
/*
|
||||
* try loading (reloading if necessary) the filter file before bothering
|
||||
* to create any JS-objects
|
||||
*/
|
||||
if (!compileJSCookieFilters()) {
|
||||
JS_EndRequest(filter_context);
|
||||
return JSCF_error;
|
||||
}
|
||||
|
||||
if (!error_reporter_installed)
|
||||
{
|
||||
error_reporter_installed = JS_TRUE;
|
||||
previous_error_reporter = JS_SetErrorReporter(filter_context,
|
||||
jscookie_ErrorReporter);
|
||||
}
|
||||
|
||||
|
||||
cookie_obj = newCookieObject();
|
||||
if( (JSObject *)0 == cookie_obj ) {
|
||||
JS_EndRequest(filter_context);
|
||||
return JSCF_error;
|
||||
}
|
||||
|
||||
cookie_data = (JSCookieData *)JS_GetPrivate(filter_context, cookie_obj);
|
||||
cookie_data->js_context = filter_context;
|
||||
cookie_data->js_object = cookie_obj;
|
||||
cookie_data->data = data;
|
||||
cookie_data->property_changed = FALSE;
|
||||
cookie_data->rejected = FALSE;
|
||||
cookie_data->accepted = FALSE;
|
||||
cookie_data->decision_made = FALSE;
|
||||
|
||||
filter_arg = OBJECT_TO_JSVAL(cookie_obj);
|
||||
JS_CallFunctionName(filter_context, filter_obj, script_name, 1,
|
||||
&filter_arg, &result);
|
||||
|
||||
JS_EndRequest(filter_context);
|
||||
|
||||
*data_changed = cookie_data->property_changed;
|
||||
if( cookie_data->decision_made ) {
|
||||
if( cookie_data->rejected )
|
||||
return JSCF_reject;
|
||||
else if( cookie_data->accepted )
|
||||
return JSCF_accept;
|
||||
else if( cookie_data->ask )
|
||||
return JSCF_ask;
|
||||
}
|
||||
|
||||
return JSCF_whatever;
|
||||
}
|
||||
|
||||
PUBLIC void
|
||||
JSCF_Cleanup(void)
|
||||
{
|
||||
TRACEMSG(("+Cleaning up JS Cookie Filters"));
|
||||
|
||||
need_compile = JS_TRUE;
|
||||
|
||||
if (filter_context)
|
||||
{
|
||||
JS_BeginRequest(filter_context);
|
||||
if (error_reporter_installed)
|
||||
{
|
||||
error_reporter_installed = JS_FALSE;
|
||||
JS_SetErrorReporter(filter_context, previous_error_reporter);
|
||||
}
|
||||
|
||||
JS_GC(filter_context);
|
||||
|
||||
destroyJSCookieFilterStuff();
|
||||
JS_EndRequest(filter_context);
|
||||
}
|
||||
}
|
||||
2888
mozilla/lib/libnet/mkaccess.c
Normal file
2888
mozilla/lib/libnet/mkaccess.c
Normal file
File diff suppressed because it is too large
Load Diff
1782
mozilla/lib/libnet/mkautocf.c
Normal file
1782
mozilla/lib/libnet/mkautocf.c
Normal file
File diff suppressed because it is too large
Load Diff
751
mozilla/lib/libnet/mkmocha.c
Normal file
751
mozilla/lib/libnet/mkmocha.c
Normal file
@@ -0,0 +1,751 @@
|
||||
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
|
||||
/* Please leave at the top for windows precompiled headers */
|
||||
#include "mkutils.h"
|
||||
|
||||
#include <stddef.h>
|
||||
#include <memory.h>
|
||||
#include <time.h>
|
||||
#include "net.h"
|
||||
#include "xp.h"
|
||||
#include "libmocha.h"
|
||||
#include "mkgeturl.h"
|
||||
#include "mkmocha.h"
|
||||
#include "libevent.h"
|
||||
#include "fe_proto.h"
|
||||
#include "pa_tags.h" /* included via -I../libparse */
|
||||
#include "libi18n.h" /* unicode */
|
||||
#include "layout.h" /* for lo_ContextToCell only */
|
||||
|
||||
extern char lm_unknown_origin_str[];
|
||||
|
||||
extern int MK_OUT_OF_MEMORY;
|
||||
extern int MK_MALFORMED_URL_ERROR;
|
||||
|
||||
typedef struct {
|
||||
char * buffer;
|
||||
size_t offset;
|
||||
size_t length;
|
||||
MWContext * context;
|
||||
char * content_type;
|
||||
int16 char_set;
|
||||
} MochaStream;
|
||||
|
||||
typedef struct {
|
||||
int32 ref_count;
|
||||
ActiveEntry * active_entry;
|
||||
PRPackedBool is_valid;
|
||||
PRPackedBool eval_what;
|
||||
PRPackedBool single_shot;
|
||||
PRPackedBool polling;
|
||||
char * str;
|
||||
size_t len;
|
||||
MWContext * context;
|
||||
int status;
|
||||
char * wysiwyg_url;
|
||||
char * base_href;
|
||||
NET_StreamClass * stream;
|
||||
} MochaConData;
|
||||
|
||||
#define HOLD_CON_DATA(con_data) ((con_data)->ref_count++)
|
||||
#define DROP_CON_DATA(con_data) { \
|
||||
if (--(con_data)->ref_count == 0) \
|
||||
free_con_data(con_data); \
|
||||
}
|
||||
|
||||
static void
|
||||
free_con_data(MochaConData * con_data)
|
||||
{
|
||||
XP_FREEIF(con_data->str);
|
||||
XP_FREEIF(con_data->wysiwyg_url);
|
||||
XP_FREEIF(con_data->base_href);
|
||||
XP_FREE(con_data);
|
||||
}
|
||||
|
||||
#define START_POLLING(ae, con_data) { \
|
||||
(con_data)->polling = TRUE; \
|
||||
NET_SetCallNetlibAllTheTime((ae)->window_id, "mkmocha"); \
|
||||
}
|
||||
|
||||
#define STOP_POLLING(ae, con_data) { \
|
||||
NET_ClearCallNetlibAllTheTime((ae)->window_id, "mkmocha"); \
|
||||
(con_data)->polling = FALSE; \
|
||||
}
|
||||
|
||||
/* forward decl */
|
||||
PRIVATE int32 net_ProcessMocha(ActiveEntry * ae);
|
||||
|
||||
/*
|
||||
* Add the new bits to our buffer
|
||||
*/
|
||||
PRIVATE int
|
||||
mocha_process(NET_StreamClass *stream, const char *str, int32 len)
|
||||
{
|
||||
MochaStream * mocha_stream = (MochaStream *) stream->data_object;
|
||||
|
||||
mocha_stream->length += len;
|
||||
if (!mocha_stream->buffer) {
|
||||
mocha_stream->buffer = (char *)XP_ALLOC(mocha_stream->length);
|
||||
}
|
||||
else {
|
||||
mocha_stream->buffer = (char *)XP_REALLOC(mocha_stream->buffer,
|
||||
mocha_stream->length);
|
||||
}
|
||||
if (!mocha_stream->buffer) {
|
||||
return MK_OUT_OF_MEMORY;
|
||||
}
|
||||
memcpy(mocha_stream->buffer + mocha_stream->offset, str, len);
|
||||
mocha_stream->offset += len;
|
||||
return len;
|
||||
}
|
||||
|
||||
PRIVATE unsigned int
|
||||
mocha_ready(NET_StreamClass *stream)
|
||||
{
|
||||
return MAX_WRITE_READY; /* always ready for writing */
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* All of the processing for this needs to be done in the mocha thread
|
||||
*/
|
||||
PRIVATE void
|
||||
mocha_complete(NET_StreamClass *stream)
|
||||
{
|
||||
void * data;
|
||||
JSBool isUnicode = JS_FALSE;
|
||||
|
||||
MochaStream * mocha_stream = (MochaStream *) stream->data_object;
|
||||
|
||||
if (mocha_stream->char_set != CS_DEFAULT) {
|
||||
uint32 len;
|
||||
INTL_Unicode * unicode;
|
||||
|
||||
/* find out how many unicode characters we'll end up with */
|
||||
len = INTL_TextToUnicodeLen(mocha_stream->char_set,
|
||||
(unsigned char *) mocha_stream->buffer,
|
||||
mocha_stream->length);
|
||||
unicode = XP_ALLOC(sizeof(INTL_Unicode) * len);
|
||||
if (!unicode)
|
||||
return;
|
||||
|
||||
/* do the conversion */
|
||||
mocha_stream->length = INTL_TextToUnicode(mocha_stream->char_set,
|
||||
(unsigned char *) mocha_stream->buffer,
|
||||
mocha_stream->length,
|
||||
unicode,
|
||||
len);
|
||||
|
||||
data = unicode;
|
||||
isUnicode = JS_TRUE;
|
||||
|
||||
XP_FREE(mocha_stream->buffer);
|
||||
mocha_stream->buffer = NULL;
|
||||
}
|
||||
else {
|
||||
data = mocha_stream->buffer;
|
||||
}
|
||||
|
||||
/* this will grab ownership of data */
|
||||
ET_MochaStreamComplete(mocha_stream->context, data,
|
||||
mocha_stream->length,
|
||||
mocha_stream->content_type,
|
||||
isUnicode);
|
||||
|
||||
XP_FREEIF(mocha_stream->content_type);
|
||||
XP_FREE(mocha_stream);
|
||||
|
||||
}
|
||||
|
||||
PRIVATE void
|
||||
mocha_abort(NET_StreamClass *stream, int status)
|
||||
{
|
||||
MochaStream * mocha_stream = (MochaStream *) stream->data_object;
|
||||
|
||||
ET_MochaStreamAbort(mocha_stream->context, status);
|
||||
XP_FREE(mocha_stream->buffer);
|
||||
XP_FREEIF(mocha_stream->content_type);
|
||||
XP_FREE(mocha_stream);
|
||||
}
|
||||
|
||||
int16
|
||||
net_check_for_charset(URL_Struct *url_struct)
|
||||
{
|
||||
int i, max;
|
||||
char *key, *value;
|
||||
static char charset[] = "charset=";
|
||||
int len = XP_STRLEN(charset);
|
||||
|
||||
max = url_struct->all_headers.empty_index;
|
||||
|
||||
for (i = 0; i < max; i++) {
|
||||
key = url_struct->all_headers.key[i];
|
||||
|
||||
/* keep looking until we find the content type one */
|
||||
if (XP_STRCASECMP(key, "Content-type"))
|
||||
continue;
|
||||
|
||||
value = url_struct->all_headers.value[i];
|
||||
|
||||
/* don't bother unless this is a JS file to begin with */
|
||||
if (!strcasestr(value, APPLICATION_JAVASCRIPT))
|
||||
return CS_DEFAULT;
|
||||
|
||||
value = XP_STRTOK(value, ";");
|
||||
while (value) {
|
||||
value = XP_StripLine(value);
|
||||
|
||||
if (!strncasecomp(value, charset, len)) {
|
||||
value += len;
|
||||
value = XP_StripLine(value);
|
||||
return (INTL_CharSetNameToID(value));
|
||||
}
|
||||
|
||||
/* move to next arg */
|
||||
value = XP_STRTOK(NULL, ";");
|
||||
|
||||
}
|
||||
|
||||
/* found content-type but no charset */
|
||||
return CS_DEFAULT;
|
||||
|
||||
}
|
||||
|
||||
/* didn't find content-type */
|
||||
return CS_DEFAULT;
|
||||
}
|
||||
|
||||
static char *
|
||||
getOriginFromURLStruct(MWContext *context, URL_Struct *url_struct)
|
||||
{
|
||||
char *referer;
|
||||
/*
|
||||
* Look in url_struct->origin_url for this javascript: URL's
|
||||
* original referrer.
|
||||
*
|
||||
* In the basis case, a javascript: or *.js URL targets a context
|
||||
* from a (the same, or not) context loaded with a non-javascript URL.
|
||||
* The referring document's URL is in url_struct->referer and we
|
||||
* duplicate it as origin_url. If we find a non-null origin_url
|
||||
* later, we know by induction where it came from.
|
||||
*/
|
||||
referer = url_struct->origin_url;
|
||||
if (referer == NULL) {
|
||||
/*
|
||||
* url_struct->referer (sic) tells the URL of the page in
|
||||
* which a javascript: or *.js link or form was clicked or submitted.
|
||||
* If it's non-null, but the context is a frame cell that's
|
||||
* being (re-)created for this load, don't use referer as the
|
||||
* decoder's source URL for the evaluation, because the FE has
|
||||
* arbitrarily set it to the top frameset's URL. Instead, use
|
||||
* the immediate parent frameset context's wysiwyg URL to get
|
||||
* the origin of the generator (or the parent's address URL if
|
||||
* not wysiwyg).
|
||||
*
|
||||
* If referer is null, the user typed this javascript: URL or
|
||||
* its frameset's URL directly into the Location toolbar.
|
||||
*/
|
||||
referer = url_struct->referer;
|
||||
if (referer) {
|
||||
lo_GridRec *grid = NULL;
|
||||
|
||||
if (context->is_grid_cell &&
|
||||
!lo_ContextToCell(context, FALSE, &grid)) {
|
||||
/*
|
||||
* Context is a frame being (re)created: veto referer.
|
||||
* The javascript: or *.js URL can't be a LAYER SRC= URL in a
|
||||
* frame because the frame's cell must point to its
|
||||
* context by the time the first tag (even LAYER) is
|
||||
* processed by layout.
|
||||
*/
|
||||
referer = NULL;
|
||||
}
|
||||
}
|
||||
if (!referer) {
|
||||
History_entry *he;
|
||||
|
||||
if (context->grid_parent) {
|
||||
/*
|
||||
* If grid parent, use its history entry to get the
|
||||
* wysiwyg or real URL, which tells the subject origin
|
||||
* of (any code in it that may have generated) this
|
||||
* javascript: or *.js URL open. If no grid parent, this must
|
||||
* be a javascript: or *.js URL that was typed directly into
|
||||
* Location.
|
||||
*/
|
||||
context = context->grid_parent;
|
||||
}
|
||||
he = SHIST_GetCurrent(&context->hist);
|
||||
if (!he) {
|
||||
referer = lm_unknown_origin_str;
|
||||
} else {
|
||||
referer = he->wysiwyg_url;
|
||||
if (!referer)
|
||||
referer = he->address;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
XP_ASSERT(referer);
|
||||
referer = XP_STRDUP(referer);
|
||||
if (!referer) {
|
||||
return NULL;
|
||||
}
|
||||
url_struct->origin_url = referer;
|
||||
return referer;
|
||||
}
|
||||
|
||||
NET_StreamClass *
|
||||
NET_CreateMochaConverter(FO_Present_Types format_out,
|
||||
void *data_object,
|
||||
URL_Struct *url_struct,
|
||||
MWContext *context)
|
||||
{
|
||||
MochaStream * mocha_stream;
|
||||
NET_StreamClass *stream;
|
||||
char *origin;
|
||||
|
||||
mocha_stream = (MochaStream *) XP_NEW_ZAP(MochaStream);
|
||||
if (!mocha_stream)
|
||||
return NULL;
|
||||
|
||||
mocha_stream->context = context;
|
||||
mocha_stream->content_type = XP_STRDUP(url_struct->content_type);
|
||||
mocha_stream->char_set = net_check_for_charset(url_struct);
|
||||
|
||||
/* Get the origin from the URL struct. We don't have to free origin
|
||||
* here because url_struct->origin_url owns it.
|
||||
*/
|
||||
origin = getOriginFromURLStruct(context, url_struct);
|
||||
if (origin == NULL)
|
||||
return NULL;
|
||||
|
||||
if (NET_URL_Type(url_struct->address) == FILE_TYPE_URL &&
|
||||
NET_URL_Type(origin) != FILE_TYPE_URL)
|
||||
{
|
||||
/*
|
||||
* Don't allow loading a file: URL from a non-file URL to
|
||||
* prevent privacy attacks against the local machine from
|
||||
* web pages.
|
||||
*/
|
||||
return NULL;
|
||||
}
|
||||
|
||||
stream = NET_NewStream("mocha", mocha_process, mocha_complete,
|
||||
mocha_abort, mocha_ready, mocha_stream,
|
||||
context);
|
||||
return stream;
|
||||
}
|
||||
|
||||
PRIVATE void
|
||||
mk_mocha_eval_exit_fn(void * data, char * str, size_t len, char * wysiwyg_url,
|
||||
char * base_href, Bool valid)
|
||||
{
|
||||
MochaConData * con_data = (MochaConData *) data;
|
||||
|
||||
if (!valid) {
|
||||
con_data->status = MK_MALFORMED_URL_ERROR;
|
||||
con_data->is_valid = TRUE;
|
||||
return;
|
||||
}
|
||||
if (str == NULL) {
|
||||
con_data->status = MK_DATA_LOADED;
|
||||
con_data->is_valid = TRUE;
|
||||
return;
|
||||
}
|
||||
|
||||
con_data->base_href = base_href;
|
||||
con_data->wysiwyg_url = wysiwyg_url;
|
||||
con_data->str = str;
|
||||
con_data->len = len;
|
||||
con_data->is_valid = TRUE;
|
||||
|
||||
}
|
||||
|
||||
/*
|
||||
* Handle both 'mocha:<stuff>' urls and the mocha type-in widget
|
||||
*/
|
||||
MODULE_PRIVATE int32
|
||||
net_MochaLoad(ActiveEntry *ae)
|
||||
{
|
||||
MWContext *context;
|
||||
URL_Struct *url_struct;
|
||||
char *what;
|
||||
Bool eval_what, single_shot;
|
||||
MochaConData * con_data;
|
||||
|
||||
context = ae->window_id;
|
||||
url_struct = ae->URL_s;
|
||||
what = XP_STRCHR(url_struct->address, ':');
|
||||
XP_ASSERT(what);
|
||||
what++;
|
||||
eval_what = FALSE;
|
||||
single_shot = (*what != '?');
|
||||
|
||||
if (single_shot) {
|
||||
/* Don't use an existing Mocha output window's stream. */
|
||||
if (*what == '\0') {
|
||||
/* Generate two grid cells, one for output and one for input. */
|
||||
what = PR_smprintf("<frameset rows=\"75%%,25%%\">\n"
|
||||
"<frame name=MochaOutput src=about:blank>\n"
|
||||
"<frame name=MochaInput src=%.*s#input>\n"
|
||||
"</frameset>",
|
||||
what - url_struct->address,
|
||||
url_struct->address);
|
||||
} else if (!XP_STRCMP(what, "#input")) {
|
||||
/* The input cell contains a form with one magic isindex field. */
|
||||
what = PR_smprintf("<b>%.*s typein</b>\n"
|
||||
"<form action=%.*s target=MochaOutput"
|
||||
" onsubmit='this.isindex.focus()'>\n"
|
||||
"<input name=isindex size=60>\n"
|
||||
"</form>",
|
||||
what - url_struct->address - 1,
|
||||
url_struct->address,
|
||||
what - url_struct->address,
|
||||
url_struct->address);
|
||||
url_struct->internal_url = TRUE;
|
||||
} else {
|
||||
eval_what = TRUE;
|
||||
}
|
||||
} else {
|
||||
/* Use the Mocha output window if it exists. */
|
||||
url_struct->auto_scroll = 1000;
|
||||
|
||||
/* Skip the leading question-mark and clean up the string. */
|
||||
what++;
|
||||
NET_PlusToSpace(what);
|
||||
NET_UnEscape(what);
|
||||
eval_what = TRUE;
|
||||
}
|
||||
|
||||
/* something got hosed. bail */
|
||||
if (!what) {
|
||||
ae->status = MK_OUT_OF_MEMORY;
|
||||
return -1;
|
||||
}
|
||||
|
||||
/* make space for the connection data */
|
||||
con_data = XP_NEW_ZAP(MochaConData);
|
||||
if (!con_data) {
|
||||
ae->status = MK_OUT_OF_MEMORY;
|
||||
return -1;
|
||||
}
|
||||
|
||||
/* remember for next time */
|
||||
con_data->ref_count = 1;
|
||||
con_data->active_entry = ae;
|
||||
ae->con_data = con_data;
|
||||
|
||||
/* set up some state so we remember where we are */
|
||||
con_data->eval_what = eval_what;
|
||||
con_data->single_shot = single_shot;
|
||||
con_data->context = context;
|
||||
|
||||
/* fake out netlib so we don't select on the socket id */
|
||||
ae->socket = NULL;
|
||||
ae->local_file = TRUE;
|
||||
|
||||
if (eval_what) {
|
||||
char *referer;
|
||||
JSPrincipals *principals;
|
||||
ETEvalStuff *stuff;
|
||||
|
||||
referer = getOriginFromURLStruct(context, url_struct);
|
||||
if (!referer) {
|
||||
ae->status = MK_OUT_OF_MEMORY;
|
||||
return -1;
|
||||
}
|
||||
|
||||
principals = LM_NewJSPrincipals(NULL, NULL, referer);
|
||||
if (!principals) {
|
||||
ae->status = MK_OUT_OF_MEMORY;
|
||||
return -1;
|
||||
}
|
||||
|
||||
/*
|
||||
* send the buffer off to be evaluated
|
||||
*/
|
||||
stuff = (ETEvalStuff *) XP_NEW_ZAP(ETEvalStuff);
|
||||
if (!stuff) {
|
||||
ae->status = MK_OUT_OF_MEMORY;
|
||||
return -1;
|
||||
}
|
||||
|
||||
stuff->len = XP_STRLEN(what);
|
||||
stuff->line_no = 0;
|
||||
stuff->scope_to = NULL;
|
||||
stuff->want_result = JS_TRUE;
|
||||
stuff->data = con_data;
|
||||
stuff->version = JSVERSION_UNKNOWN;
|
||||
stuff->principals = principals;
|
||||
|
||||
ET_EvaluateScript(context, what, stuff, mk_mocha_eval_exit_fn);
|
||||
|
||||
}
|
||||
else {
|
||||
|
||||
/* allocated above, don't need to free */
|
||||
con_data->str = what;
|
||||
con_data->len = XP_STRLEN(what);
|
||||
con_data->is_valid = TRUE;
|
||||
|
||||
}
|
||||
|
||||
/* make sure netlib gets called so we know when our data gets back */
|
||||
START_POLLING(ae, con_data);
|
||||
|
||||
/* ya'll come back now, ya'hear? */
|
||||
return net_ProcessMocha(ae);
|
||||
|
||||
}
|
||||
|
||||
PRIVATE int
|
||||
net_process_mocha(MochaConData * con_data)
|
||||
{
|
||||
int32 ref_count;
|
||||
|
||||
ref_count = con_data->ref_count;
|
||||
DROP_CON_DATA(con_data);
|
||||
if (ref_count == 1 || !con_data->active_entry)
|
||||
return -1;
|
||||
return net_ProcessMocha(con_data->active_entry);
|
||||
}
|
||||
|
||||
static char nscp_open_tag[] = "<" PT_NSCP_OPEN ">";
|
||||
|
||||
/*
|
||||
* If the mocha has finished evaluation shove the result
|
||||
* down the stream and continue else just wait
|
||||
*/
|
||||
PRIVATE int32
|
||||
net_ProcessMocha(ActiveEntry * ae)
|
||||
{
|
||||
FO_Present_Types output_format;
|
||||
Bool to_layout;
|
||||
Bool first_time;
|
||||
NET_StreamClass *stream = NULL;
|
||||
MochaConData * con_data = (MochaConData *) ae->con_data;
|
||||
MWContext * context;
|
||||
int status;
|
||||
|
||||
/* if we haven't gotten our data yet just return and wait */
|
||||
if (!con_data || !con_data->is_valid)
|
||||
return 0;
|
||||
|
||||
context = ae->window_id;
|
||||
|
||||
/*
|
||||
* Race with the mocha thread until we can grab the JSLock
|
||||
*/
|
||||
if (!con_data->single_shot) {
|
||||
MochaDecoder * decoder;
|
||||
|
||||
HOLD_CON_DATA(con_data);
|
||||
if (!LM_AttemptLockJS(context,
|
||||
(JSLockReleaseFunc)net_process_mocha, con_data))
|
||||
return 0;
|
||||
DROP_CON_DATA(con_data);
|
||||
decoder = LM_GetMochaDecoder(context);
|
||||
if (!decoder) {
|
||||
LM_UnlockJS(context);
|
||||
ae->status = MK_OUT_OF_MEMORY;
|
||||
goto done;
|
||||
}
|
||||
stream = decoder->stream;
|
||||
LM_PutMochaDecoder(decoder);
|
||||
LM_UnlockJS(context);
|
||||
}
|
||||
else {
|
||||
stream = con_data->stream;
|
||||
}
|
||||
|
||||
/* we've gotten valid data, clear the callme all the time flag */
|
||||
STOP_POLLING(ae, con_data);
|
||||
|
||||
/* see if there were any problems */
|
||||
if (con_data->status < 0 || con_data->str == NULL) {
|
||||
ET_SendLoadEvent(context, EVENT_LOAD, NULL, NULL,
|
||||
LO_DOCUMENT_LAYER_ID, FALSE);
|
||||
ae->status = con_data->status;
|
||||
goto done;
|
||||
}
|
||||
|
||||
/*
|
||||
* If we don't already have a stream to take our output create one now
|
||||
*/
|
||||
first_time = !stream;
|
||||
if (first_time) {
|
||||
StrAllocCopy(ae->URL_s->content_type, TEXT_HTML);
|
||||
ae->format_out = CLEAR_CACHE_BIT(ae->format_out);
|
||||
|
||||
stream = NET_StreamBuilder(ae->format_out, ae->URL_s, ae->window_id);
|
||||
if (!stream) {
|
||||
ae->status = MK_UNABLE_TO_CONVERT;
|
||||
goto done;
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* If the stream we just created isn't ready for writing just
|
||||
* hold onto the stream and try again later
|
||||
*/
|
||||
if (!stream->is_write_ready(stream)) {
|
||||
con_data->stream = stream;
|
||||
START_POLLING(ae, con_data);
|
||||
return 0;
|
||||
}
|
||||
|
||||
/* XXX this condition is fairly bogus */
|
||||
output_format = CLEAR_CACHE_BIT(ae->format_out);
|
||||
to_layout = (output_format != FO_INTERNAL_IMAGE &&
|
||||
output_format != FO_MULTIPART_IMAGE &&
|
||||
output_format != FO_EMBED &&
|
||||
output_format != FO_PLUGIN);
|
||||
|
||||
if (to_layout) {
|
||||
/* The string must end in a newline so the parser will flush it. */
|
||||
if (con_data->len != 0 && con_data->str[con_data->len-1] != '\n') {
|
||||
size_t new_len = con_data->len + 1;
|
||||
char * new_str = XP_ALLOC((new_len + 1) * sizeof(char));
|
||||
|
||||
if (!new_str) {
|
||||
ae->status = MK_OUT_OF_MEMORY;
|
||||
goto done;
|
||||
}
|
||||
XP_MEMCPY(new_str, con_data->str, con_data->len);
|
||||
new_str[new_len-1] = '\n';
|
||||
new_str[new_len] = '\0';
|
||||
con_data->str = new_str;
|
||||
con_data->len = new_len;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* If this is the first time do some initial setup. We'll set
|
||||
* the window title and maybe shove out a <BASE> tag
|
||||
*/
|
||||
status = 0;
|
||||
if (to_layout && first_time && con_data->eval_what) {
|
||||
|
||||
/* Feed layout an internal tag so it will create a new top state. */
|
||||
stream->put_block(stream, nscp_open_tag,
|
||||
sizeof nscp_open_tag - 1);
|
||||
|
||||
(void) LM_WysiwygCacheConverter(context, ae->URL_s,
|
||||
con_data->wysiwyg_url,
|
||||
con_data->base_href);
|
||||
|
||||
if (*con_data->str != '<') {
|
||||
char * prefix = NULL;
|
||||
StrAllocCopy(prefix, "<TITLE>");
|
||||
StrAllocCat(prefix, ae->URL_s->address);
|
||||
StrAllocCat(prefix, "</TITLE><PLAINTEXT>");
|
||||
if (!prefix) {
|
||||
ae->status = MK_OUT_OF_MEMORY;
|
||||
goto done;
|
||||
}
|
||||
status = (*stream->put_block)(stream, prefix,
|
||||
XP_STRLEN(prefix));
|
||||
XP_FREE(prefix);
|
||||
}
|
||||
else {
|
||||
if (con_data->base_href) {
|
||||
status = (*stream->put_block)(stream,
|
||||
con_data->base_href,
|
||||
XP_STRLEN(con_data->base_href));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (status >= 0) {
|
||||
status = (*stream->put_block)(stream, con_data->str,
|
||||
(int32)con_data->len);
|
||||
}
|
||||
|
||||
if (con_data->single_shot && status >= 0)
|
||||
(*stream->complete)(stream);
|
||||
|
||||
if (!con_data->single_shot && status >= 0) {
|
||||
if (first_time) {
|
||||
ET_SetDecoderStream(context, stream, ae->URL_s, JS_TRUE);
|
||||
goto done;
|
||||
}
|
||||
} else {
|
||||
if (status < 0)
|
||||
(*stream->abort)(stream, status);
|
||||
if (first_time)
|
||||
XP_DELETE(stream);
|
||||
}
|
||||
|
||||
ae->status = MK_DATA_LOADED;
|
||||
|
||||
done:
|
||||
ae->con_data = NULL;
|
||||
con_data->active_entry = NULL;
|
||||
DROP_CON_DATA(con_data);
|
||||
return -1;
|
||||
|
||||
}
|
||||
|
||||
PRIVATE int32
|
||||
net_InterruptMocha(ActiveEntry *ae)
|
||||
{
|
||||
MochaConData * con_data = (MochaConData *) ae->con_data;
|
||||
|
||||
if (!con_data)
|
||||
return MK_INTERRUPTED;
|
||||
|
||||
/* do we need to decrement the callme all the time flag? */
|
||||
if (con_data->polling) {
|
||||
STOP_POLLING(ae, con_data);
|
||||
}
|
||||
|
||||
/* ae is about to go away, break its connection with con_data */
|
||||
ae->con_data = NULL;
|
||||
con_data->active_entry = NULL;
|
||||
|
||||
/* ae is about to go away, better get it off the JS lock waiters list */
|
||||
if (LM_ClearAttemptLockJS(con_data->context,
|
||||
(JSLockReleaseFunc)net_process_mocha, con_data))
|
||||
DROP_CON_DATA(con_data);
|
||||
|
||||
return ae->status = MK_INTERRUPTED;
|
||||
}
|
||||
|
||||
PRIVATE void
|
||||
net_CleanupMocha(void)
|
||||
{
|
||||
/* nothing so far needs freeing */
|
||||
return;
|
||||
}
|
||||
|
||||
MODULE_PRIVATE void
|
||||
NET_InitMochaProtocol(void)
|
||||
{
|
||||
static NET_ProtoImpl mocha_proto_impl;
|
||||
|
||||
mocha_proto_impl.init = net_MochaLoad;
|
||||
mocha_proto_impl.process = net_ProcessMocha;
|
||||
mocha_proto_impl.interrupt = net_InterruptMocha;
|
||||
mocha_proto_impl.cleanup = net_CleanupMocha;
|
||||
|
||||
NET_RegisterProtocolImplementation(&mocha_proto_impl, MOCHA_TYPE_URL);
|
||||
}
|
||||
|
||||
2227
mozilla/lib/libparse/pa_mdl.c
Normal file
2227
mozilla/lib/libparse/pa_mdl.c
Normal file
File diff suppressed because it is too large
Load Diff
187
mozilla/modules/libhook/src/hk_hook.c
Normal file
187
mozilla/modules/libhook/src/hk_hook.c
Normal file
@@ -0,0 +1,187 @@
|
||||
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
#include "xp_core.h"
|
||||
#include "xp_mcom.h"
|
||||
#include "jsapi.h"
|
||||
#include "prefapi.h"
|
||||
#include "hk_funcs.h"
|
||||
|
||||
#include "hk_private.h"
|
||||
|
||||
|
||||
static JSObject *HookObject = NULL;
|
||||
|
||||
|
||||
JSObject *
|
||||
hk_GetHookObject(void)
|
||||
{
|
||||
return HookObject;
|
||||
}
|
||||
|
||||
|
||||
void
|
||||
hk_SetHookObject(JSObject *hook_obj)
|
||||
{
|
||||
HookObject = hook_obj;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Some hooks have dynamic names and can't be in the
|
||||
* fast hook array lookup, this covers looking up those
|
||||
* hooks. For example, if I invented a <BLURT> tag,
|
||||
* this would look for a BLURT_hook function.
|
||||
*/
|
||||
intn
|
||||
hk_IsUnknownTagHook(void *extra)
|
||||
{
|
||||
const char *hook_func;
|
||||
jsval tmp_val;
|
||||
JSContext *j_context;
|
||||
|
||||
hook_func = HK_GetFunctionName(HK_TAG, extra);
|
||||
if (hook_func == NULL)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (!PREF_GetConfigContext(&j_context))
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
if ((j_context == NULL)||(HookObject == NULL))
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
JS_BeginRequest(j_context);
|
||||
if ((JS_GetProperty(j_context, HookObject, hook_func, &tmp_val))&&
|
||||
(JS_TypeOfValue(j_context, tmp_val) == JSTYPE_FUNCTION))
|
||||
{
|
||||
JS_EndRequest(j_context);
|
||||
return 1;
|
||||
}
|
||||
JS_EndRequest(j_context);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* There is no guarantee that someone has checked the existence of the
|
||||
* hook before calling it, so we check again here. We don't use the
|
||||
* fast array lookup since it can't catch all hooks anyway, and we
|
||||
* may well have to fall back to the slow method.
|
||||
*/
|
||||
intn
|
||||
HK_CallHook(int32 hook_id, void *extra, int32 window_id,
|
||||
char *hook_str, char **hook_ret)
|
||||
{
|
||||
const char *hook_func;
|
||||
intn ok;
|
||||
jsval tmp_val;
|
||||
jsval argv[2];
|
||||
JSContext *j_context;
|
||||
JSString *str;
|
||||
const char *result_str;
|
||||
char *return_str;
|
||||
|
||||
*hook_ret = NULL;
|
||||
|
||||
if (hook_str == NULL)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* Make a function name form the hook_is and possibly the PA_Tag
|
||||
* pointed to by extra.
|
||||
*/
|
||||
hook_func = HK_GetFunctionName(hook_id, extra);
|
||||
if (hook_func == NULL)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* Make sure you have a javascript context and object.
|
||||
*/
|
||||
if (!PREF_GetConfigContext(&j_context))
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
if ((j_context == NULL)||(HookObject == NULL))
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
JS_BeginRequest(j_context);
|
||||
/*
|
||||
* Check that there is a function to call.
|
||||
*/
|
||||
if ((!JS_GetProperty(j_context, HookObject, hook_func, &tmp_val))||
|
||||
(JS_TypeOfValue(j_context, tmp_val) != JSTYPE_FUNCTION))
|
||||
{
|
||||
JS_EndRequest(j_context);
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* Create the argument/parameter list, and call the function.
|
||||
*/
|
||||
str = JS_NewStringCopyZ(j_context, hook_str);
|
||||
if (str == NULL)
|
||||
{
|
||||
JS_EndRequest(j_context);
|
||||
return 0;
|
||||
}
|
||||
argv[0] = STRING_TO_JSVAL(str);
|
||||
argv[1] = INT_TO_JSVAL(window_id);
|
||||
if (!JS_CallFunctionName(j_context, HookObject, hook_func, 2, argv,
|
||||
&tmp_val))
|
||||
{
|
||||
JS_EndRequest(j_context);
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* A false return from the function means leave the
|
||||
* passed string unchanged.
|
||||
*/
|
||||
if (tmp_val != JSVAL_FALSE)
|
||||
{
|
||||
str = JS_ValueToString(j_context, tmp_val);
|
||||
if (str == NULL)
|
||||
{
|
||||
JS_EndRequest(j_context);
|
||||
return 0;
|
||||
}
|
||||
result_str = JS_GetStringBytes(str);
|
||||
return_str = XP_STRDUP(result_str);
|
||||
if (return_str == NULL)
|
||||
{
|
||||
JS_EndRequest(j_context);
|
||||
return 0;
|
||||
}
|
||||
*hook_ret = return_str;
|
||||
}
|
||||
JS_EndRequest(j_context);
|
||||
|
||||
return 1;
|
||||
}
|
||||
414
mozilla/modules/libhook/src/hk_init.c
Normal file
414
mozilla/modules/libhook/src/hk_init.c
Normal file
@@ -0,0 +1,414 @@
|
||||
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
#include "xp_core.h"
|
||||
#include "xp_mcom.h"
|
||||
#include "hk_types.h"
|
||||
#include "jsapi.h"
|
||||
#include "prefapi.h"
|
||||
#include "ntypes.h"
|
||||
#include "structs.h"
|
||||
#include "pa_tags.h"
|
||||
|
||||
#include "hk_private.h"
|
||||
|
||||
#ifdef XP_MAC
|
||||
#include "hk_funcs.h"
|
||||
#endif
|
||||
|
||||
|
||||
static hk_FunctionRec **FunctionList = NULL;
|
||||
static int32 FunctionCount = 0;
|
||||
|
||||
static char *hk_FunctionStrings[HK_MAX] = {
|
||||
NULL,
|
||||
"location_hook",
|
||||
"_hook",
|
||||
"document_start_hook"};
|
||||
|
||||
static JSClass autoconf_class = {
|
||||
"HookConfig", 0,
|
||||
hk_HookObjectAddProperty, hk_HookObjectDeleteProperty,
|
||||
JS_PropertyStub, hk_HookObjectSetProperty,
|
||||
JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, JS_FinalizeStub
|
||||
};
|
||||
|
||||
|
||||
/*******************************************
|
||||
* This function really bugs me! It needs to
|
||||
* be super fast since it will be called for every
|
||||
* HTML tag ever processed. This means it should be
|
||||
* self-contained, and not call off to other functions.
|
||||
* Making it do that means it can't call off into
|
||||
* hk_tag.c to get inside the PA_Tag structure in extra,
|
||||
* and thus makes me include ntypes.h, structs.h, and pa_tags.h.
|
||||
********************************************/
|
||||
/*
|
||||
* A FAST function existence lookup, using an array set up in
|
||||
* the initialization process.
|
||||
*/
|
||||
intn
|
||||
HK_IsHook(int32 hook_id, void *extra)
|
||||
{
|
||||
int32 func_id;
|
||||
hk_FunctionRec *rec_ptr;
|
||||
|
||||
/*
|
||||
* The no hook case never exists.
|
||||
*/
|
||||
if (hook_id == HK_NONE)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
/*
|
||||
* Tag hooks map to the tag types, or alternatly
|
||||
* unknown tags which are handled elsewhere.
|
||||
*/
|
||||
else if (hook_id == HK_TAG)
|
||||
{
|
||||
PA_Tag *tag;
|
||||
|
||||
tag = (PA_Tag *)extra;
|
||||
if (tag->type != P_UNKNOWN)
|
||||
{
|
||||
func_id = HK_MAX - 1 + tag->type;
|
||||
}
|
||||
/*
|
||||
* P_UNKNOWN tags must be looked up the slow
|
||||
* dynamic way.
|
||||
*/
|
||||
else
|
||||
{
|
||||
return(hk_IsUnknownTagHook(extra));
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
func_id = hook_id - 1;
|
||||
}
|
||||
|
||||
/*
|
||||
* If we are outside the known funtion array, fail.
|
||||
*/
|
||||
if ((func_id < 0)||(func_id >= FunctionCount))
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* If no function is registered, fail.
|
||||
*/
|
||||
rec_ptr = FunctionList[func_id];
|
||||
if (rec_ptr == NULL)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (rec_ptr->func_exists == FALSE)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
else
|
||||
{
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Set the existence state of a particular index in the array.
|
||||
*/
|
||||
static void
|
||||
hk_set_function_existence(int32 indx, XP_Bool exists)
|
||||
{
|
||||
if ((indx < 0)||(indx >= FunctionCount))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (FunctionList[indx] != NULL)
|
||||
{
|
||||
FunctionList[indx]->func_exists = exists;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void
|
||||
hk_SetFunctionExistence(char *func_name, XP_Bool exists)
|
||||
{
|
||||
int32 i, len;
|
||||
char *tptr;
|
||||
char *up_str;
|
||||
char *ptr1, *ptr2;
|
||||
int32 indx;
|
||||
|
||||
/*
|
||||
* A NULL function one too short for the hook suffix
|
||||
* cannot be a hook function.
|
||||
*/
|
||||
if (func_name == NULL)
|
||||
{
|
||||
return;
|
||||
}
|
||||
len = XP_STRLEN(func_name);
|
||||
if (len < XP_STRLEN("_hook"))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
/*
|
||||
* If the function has no hook suffix we just don't care.
|
||||
*/
|
||||
tptr = func_name + len - XP_STRLEN("_hook");
|
||||
if (XP_STRCMP(tptr, "_hook") != 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Make an all upper-case copy of the prefix.
|
||||
*/
|
||||
*tptr = '\0';
|
||||
up_str = XP_ALLOC(XP_STRLEN(func_name) + 1);
|
||||
/*
|
||||
* If allocation fails, restore original and return.
|
||||
*/
|
||||
if (up_str == NULL)
|
||||
{
|
||||
*tptr = '_';
|
||||
return;
|
||||
}
|
||||
ptr1 = func_name;
|
||||
ptr2 = up_str;
|
||||
while (*ptr1 != '\0')
|
||||
{
|
||||
*ptr2 = (char)(XP_TO_UPPER(*ptr1));
|
||||
ptr1++;
|
||||
ptr2++;
|
||||
}
|
||||
*ptr2 = '\0';
|
||||
*tptr = '_';
|
||||
|
||||
/*
|
||||
* Check if the prefix is a known TAG name.
|
||||
*/
|
||||
indx = hk_TagStringToIndex(up_str);
|
||||
XP_FREE(up_str);
|
||||
if (indx >= 0)
|
||||
{
|
||||
indx = HK_MAX - 1 + indx;
|
||||
hk_set_function_existence(indx, exists);
|
||||
return;
|
||||
}
|
||||
|
||||
/*
|
||||
* Special check for the TEXT_hook which is a tag hook but
|
||||
* won't be caught by the hk_TagStringToIndex test.
|
||||
*/
|
||||
if (XP_STRCMP(func_name, "TEXT_hook") == 0)
|
||||
{
|
||||
indx = HK_MAX - 1 + 0;
|
||||
hk_set_function_existence(indx, exists);
|
||||
return;
|
||||
}
|
||||
|
||||
/*
|
||||
* Finally, check the array of known tag hooks.
|
||||
*/
|
||||
for (i=1; i<HK_MAX; i++)
|
||||
{
|
||||
if ((hk_FunctionStrings[i] != NULL)&&
|
||||
(XP_STRCMP(func_name, hk_FunctionStrings[i]) == 0))
|
||||
{
|
||||
indx = i - 1;
|
||||
hk_set_function_existence(indx, exists);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Free all members of the function list array up to
|
||||
* the passed index.
|
||||
*/
|
||||
static void
|
||||
hk_free_function_list(int32 indx)
|
||||
{
|
||||
int32 i;
|
||||
|
||||
for (i=0; i<indx; i++)
|
||||
{
|
||||
if (FunctionList[i] != NULL)
|
||||
{
|
||||
if (FunctionList[i]->func_name != NULL)
|
||||
{
|
||||
XP_FREE(FunctionList[i]->func_name);
|
||||
FunctionList[i]->func_name = NULL;
|
||||
}
|
||||
XP_FREE(FunctionList[i]);
|
||||
FunctionList[i] = NULL;
|
||||
}
|
||||
}
|
||||
XP_FREE(FunctionList);
|
||||
FunctionList = NULL;
|
||||
FunctionCount = 0;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Initialize the function list array to contain all the known tags
|
||||
* plus all the known special hook functions.
|
||||
*/
|
||||
static intn
|
||||
hk_initialize_function_list(void)
|
||||
{
|
||||
int32 i, indx;
|
||||
int32 tag_cnt;
|
||||
|
||||
/*
|
||||
* Subtract one from HK_MAX because it includes the unknown
|
||||
* at 0. For the tag count, unknown is -1, so we can just
|
||||
* use it as is.
|
||||
*/
|
||||
tag_cnt = hk_NumKnownTags();
|
||||
FunctionCount = HK_MAX - 1 + tag_cnt;
|
||||
FunctionList = (hk_FunctionRec **)XP_ALLOC(FunctionCount *
|
||||
sizeof(hk_FunctionRec *));
|
||||
if (FunctionList == NULL)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
indx = 0;
|
||||
/*
|
||||
* First allocate all the known special hooks.
|
||||
*/
|
||||
for (i=1; i < HK_MAX; i++)
|
||||
{
|
||||
hk_FunctionRec *rec_ptr;
|
||||
|
||||
rec_ptr = XP_NEW(hk_FunctionRec);
|
||||
if (rec_ptr == NULL)
|
||||
{
|
||||
hk_free_function_list(indx);
|
||||
return 0;
|
||||
}
|
||||
rec_ptr->func_exists = FALSE;
|
||||
rec_ptr->func_name = hk_FunctionStrings[i];
|
||||
FunctionList[indx] = rec_ptr;
|
||||
indx++;
|
||||
}
|
||||
|
||||
/*
|
||||
* Now do all known tags.
|
||||
*/
|
||||
for (i=0; i < tag_cnt; i++)
|
||||
{
|
||||
hk_FunctionRec *rec_ptr;
|
||||
|
||||
rec_ptr = XP_NEW(hk_FunctionRec);
|
||||
if (rec_ptr == NULL)
|
||||
{
|
||||
hk_free_function_list(indx);
|
||||
return 0;
|
||||
}
|
||||
rec_ptr->func_exists = FALSE;
|
||||
rec_ptr->func_name = hk_TagIndexToFunctionString(i);
|
||||
FunctionList[indx] = rec_ptr;
|
||||
indx++;
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Initialize all the libhook stuff. SHould only be called once.
|
||||
* Usually just before reading hook.js.
|
||||
*/
|
||||
intn
|
||||
HK_Init(void)
|
||||
{
|
||||
intn ret;
|
||||
JSContext *j_context;
|
||||
JSObject *j_object;
|
||||
JSObject *hook_obj;
|
||||
|
||||
/*
|
||||
* If a hook object does not already exist, create
|
||||
* one. If you cannot create one, then return failure.
|
||||
*/
|
||||
hook_obj = hk_GetHookObject();
|
||||
if (hook_obj == NULL)
|
||||
{
|
||||
if ((!PREF_GetConfigContext(&j_context))||
|
||||
(!PREF_GetGlobalConfigObject(&j_object)))
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
JS_BeginRequest(j_context);
|
||||
hook_obj = JS_DefineObject(j_context, j_object,
|
||||
"HookConfig",
|
||||
&autoconf_class,
|
||||
NULL,
|
||||
JSPROP_ENUMERATE|JSPROP_READONLY|JSPROP_PERMANENT);
|
||||
JS_EndRequest(j_context);
|
||||
}
|
||||
if (hook_obj == NULL)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
hk_SetHookObject(hook_obj);
|
||||
|
||||
ret = hk_initialize_function_list();
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Get the hook know for the passed hook id.
|
||||
*/
|
||||
const char *
|
||||
HK_GetFunctionName(int32 hook_id, void *extra)
|
||||
{
|
||||
if ((hook_id < 0)||(hook_id >= HK_MAX))
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/*
|
||||
* Special name creation for tag hooks.
|
||||
*/
|
||||
if (hook_id == HK_TAG)
|
||||
{
|
||||
const char *ret_str;
|
||||
|
||||
ret_str = (const char *)hk_TagFunctionString(
|
||||
hk_FunctionStrings[hook_id], extra);
|
||||
return ret_str;
|
||||
}
|
||||
else
|
||||
{
|
||||
return hk_FunctionStrings[hook_id];
|
||||
}
|
||||
}
|
||||
|
||||
2244
mozilla/modules/libpref/src/prefapi.c
Normal file
2244
mozilla/modules/libpref/src/prefapi.c
Normal file
File diff suppressed because it is too large
Load Diff
2244
mozilla/modules/libpref/src/prefapi.cpp
Normal file
2244
mozilla/modules/libpref/src/prefapi.cpp
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,135 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
|
||||
]>
|
||||
|
||||
|
||||
<!-- Coding standards for this document
|
||||
|
||||
* Other than the GFDL, please use the "section" tag instead of "sect1",
|
||||
"sect2", etc.
|
||||
* Use Entities to include files for new chapters in Bugzilla-Guide.xml.
|
||||
* Try to use Entities for frequently-used passages of text as well.
|
||||
* Ensure all documents compile cleanly to HTML after modification.
|
||||
The warning, "DTDDECL catalog types not supported" is normal.
|
||||
* Try to index important terms wherever possible.
|
||||
* Use "glossterm" whenever you introduce a new term.
|
||||
* Follow coding standards at http://www.tldp.org, and
|
||||
check out the KDE guidelines (they are nice, too)
|
||||
http://i18n.kde.org/doc/markup.html
|
||||
* All tags should be lowercase.
|
||||
* Please use sensible spacing. The comments at the very end of each
|
||||
file define reasonable defaults for PSGML mode in EMACS.
|
||||
* Double-indent tags, use double spacing whenever possible, and
|
||||
try to avoid clutter and feel free to waste space in the code to make it
|
||||
more readable.
|
||||
|
||||
-->
|
||||
|
||||
<book id="index">
|
||||
|
||||
<!-- Header -->
|
||||
|
||||
<bookinfo>
|
||||
<title>The Bugzilla Guide - &bz-ver;
|
||||
<!-- BZ-DEVEL -->Development <!-- /BZ-DEVEL -->
|
||||
Release</title>
|
||||
|
||||
<authorgroup>
|
||||
<corpauthor>The Bugzilla Team</corpauthor>
|
||||
</authorgroup>
|
||||
|
||||
<pubdate>&bz-date;</pubdate>
|
||||
|
||||
<abstract>
|
||||
<para>
|
||||
This is the documentation for Bugzilla, a
|
||||
bug-tracking system from mozilla.org.
|
||||
Bugzilla is an enterprise-class piece of software
|
||||
that tracks millions of bugs and issues for hundreds of
|
||||
organizations around the world.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The most current version of this document can always be found on the
|
||||
<ulink url="http://www.bugzilla.org/docs/">Bugzilla
|
||||
Documentation Page</ulink>.
|
||||
</para>
|
||||
|
||||
</abstract>
|
||||
|
||||
<keywordset>
|
||||
<keyword>Bugzilla</keyword>
|
||||
<keyword>Guide</keyword>
|
||||
<keyword>installation</keyword>
|
||||
<keyword>FAQ</keyword>
|
||||
<keyword>administration</keyword>
|
||||
<keyword>integration</keyword>
|
||||
<keyword>MySQL</keyword>
|
||||
<keyword>Mozilla</keyword>
|
||||
<keyword>webtools</keyword>
|
||||
</keywordset>
|
||||
</bookinfo>
|
||||
|
||||
<!-- About This Guide -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="about.xml" />
|
||||
|
||||
<!-- Installing Bugzilla -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="installation.xml" />
|
||||
|
||||
<!-- Administering Bugzilla -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="administration.xml" />
|
||||
|
||||
<!-- Securing Bugzilla -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="security.xml" />
|
||||
|
||||
<!-- Customizing Bugzilla -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="customization.xml" />
|
||||
|
||||
<!-- Using Bugzilla -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="using.xml" />
|
||||
|
||||
<!-- Appendix: Troubleshooting -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshooting.xml" />
|
||||
|
||||
<!-- Appendix: Custom Patches -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="patches.xml" />
|
||||
|
||||
<!-- Appendix: Manually Installing Perl Modules -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules.xml" />
|
||||
|
||||
<!-- Appendix: GNU Free Documentation License -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gfdl.xml" />
|
||||
|
||||
<!-- Glossary -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="glossary.xml" />
|
||||
|
||||
<!-- Index -->
|
||||
<!--xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="index.xml" /-->
|
||||
|
||||
</book>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,246 +0,0 @@
|
||||
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<!-- $Id: about.xml,v 1.26.4.1 2008-07-13 16:44:28 mozilla%colinogilvie.co.uk Exp $ -->
|
||||
|
||||
<chapter id="about">
|
||||
<title>About This Guide</title>
|
||||
|
||||
<section id="copyright">
|
||||
<title>Copyright Information</title>
|
||||
|
||||
<para>This document is copyright (c) 2000-¤t-year; by the various
|
||||
Bugzilla contributors who wrote it.</para>
|
||||
|
||||
<blockquote>
|
||||
<para>
|
||||
Permission is granted to copy, distribute and/or modify this
|
||||
document under the terms of the GNU Free Documentation
|
||||
License, Version 1.1 or any later version published by the
|
||||
Free Software Foundation; with no Invariant Sections, no
|
||||
Front-Cover Texts, and with no Back-Cover Texts. A copy of
|
||||
the license is included in <xref linkend="gfdl"/>.
|
||||
</para>
|
||||
</blockquote>
|
||||
<para>
|
||||
If you have any questions regarding this document, its
|
||||
copyright, or publishing this document in non-electronic form,
|
||||
please contact the Bugzilla Team.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="disclaimer">
|
||||
<title>Disclaimer</title>
|
||||
<para>
|
||||
No liability for the contents of this document can be accepted.
|
||||
Follow the instructions herein at your own risk.
|
||||
This document may contain errors
|
||||
and inaccuracies that may damage your system, cause your partner
|
||||
to leave you, your boss to fire you, your cats to
|
||||
pee on your furniture and clothing, and global thermonuclear
|
||||
war. Proceed with caution.
|
||||
</para>
|
||||
<para>
|
||||
Naming of particular products or brands should not be seen as
|
||||
endorsements, with the exception of the term "GNU/Linux". We
|
||||
wholeheartedly endorse the use of GNU/Linux; it is an extremely
|
||||
versatile, stable,
|
||||
and robust operating system that offers an ideal operating
|
||||
environment for Bugzilla.
|
||||
</para>
|
||||
<para>
|
||||
Although the Bugzilla development team has taken great care to
|
||||
ensure that all exploitable bugs have been fixed, security holes surely
|
||||
exist in any piece of code. Great care should be taken both in
|
||||
the installation and usage of this software. The Bugzilla development
|
||||
team members assume no liability for your use of Bugzilla. You have
|
||||
the source code, and are responsible for auditing it yourself to ensure
|
||||
your security needs are met.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<!-- Section 2: New Versions -->
|
||||
|
||||
<section id="newversions">
|
||||
<title>New Versions</title>
|
||||
<para>
|
||||
This is the &bz-ver; version of The Bugzilla Guide. It is so named
|
||||
to match the current version of Bugzilla.
|
||||
<!-- BZ-DEVEL --> This version of the guide, like its associated Bugzilla version, is a
|
||||
development version.<!-- /BZ-DEVEL -->
|
||||
</para>
|
||||
<para>
|
||||
The latest version of this guide can always be found at <ulink
|
||||
url="http://www.bugzilla.org"/>, or checked out via CVS by
|
||||
following the <ulink url="http://www.mozilla.org/cvs.html">Mozilla
|
||||
CVS</ulink> instructions and check out the
|
||||
<filename>mozilla/webtools/bugzilla/docs/</filename>
|
||||
subtree. However, you should read the version
|
||||
which came with the Bugzilla release you are using.
|
||||
</para>
|
||||
<para>
|
||||
The Bugzilla Guide, or a section of it, is also available in
|
||||
the following languages:
|
||||
<ulink url="http://www.traduc.org/docs/guides/lecture/bugzilla/">French</ulink>,
|
||||
<ulink url="http://bugzilla-de.sourceforge.net/docs/html/">German</ulink>,
|
||||
<ulink url="http://www.bugzilla.jp/docs/2.18/">Japanese</ulink>.
|
||||
Note that these may be outdated or not up to date.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
In addition, there are Bugzilla template localization projects in
|
||||
the following languages. They may have translated documentation
|
||||
available:
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-ar/">Arabic</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-be/">Belarusian</ulink>,
|
||||
<ulink url="http://openfmi.net/projects/mozilla-bg/">Bulgarian</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-br/">Brazilian Portuguese</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-cn/">Chinese</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-fr/">French</ulink>,
|
||||
<ulink url="http://germzilla.ganderbay.net/">German</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-it/">Italian</ulink>,
|
||||
<ulink url="http://www.bugzilla.jp/about/jp.html">Japanese</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-kr/">Korean</ulink>,
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-ru/">Russian</ulink> and
|
||||
<ulink url="http://sourceforge.net/projects/bugzilla-es/">Spanish</ulink>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If you would like to volunteer to translate the Guide into additional
|
||||
languages, please contact
|
||||
<ulink url="mailto:justdave@bugzilla.org">Dave Miller</ulink>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="credits">
|
||||
<title>Credits</title>
|
||||
<para>
|
||||
The people listed below have made enormous contributions to the
|
||||
creation of this Guide, through their writing, dedicated hacking efforts,
|
||||
numerous e-mail and IRC support sessions, and overall excellent
|
||||
contribution to the Bugzilla community:
|
||||
</para>
|
||||
|
||||
<!-- TODO: This is evil... there has to be a valid way to get this look -->
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Matthew P. Barnson <email>mbarnson@sisna.com</email></term>
|
||||
<listitem>
|
||||
<para>for the Herculean task of pulling together the Bugzilla Guide
|
||||
and shepherding it to 2.14.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Terry Weissman <email>terry@mozilla.org</email></term>
|
||||
<listitem>
|
||||
<para>for initially writing Bugzilla and creating the README upon
|
||||
which the UNIX installation documentation is largely based.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Tara Hernandez <email>tara@tequilarists.org</email></term>
|
||||
<listitem>
|
||||
<para>for keeping Bugzilla development going strong after Terry left
|
||||
mozilla.org and for running landfill.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Dave Lawrence <email>dkl@redhat.com</email></term>
|
||||
<listitem>
|
||||
<para>for providing insight into the key differences between Red
|
||||
Hat's customized Bugzilla.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Dawn Endico <email>endico@mozilla.org</email></term>
|
||||
<listitem>
|
||||
<para>for being a hacker extraordinaire and putting up with Matthew's
|
||||
incessant questions and arguments on irc.mozilla.org in #mozwebtools
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Jacob Steenhagen <email>jake@bugzilla.org</email></term>
|
||||
<listitem>
|
||||
<para>for taking over documentation during the 2.17 development
|
||||
period.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Dave Miller <email>justdave@bugzilla.org</email></term>
|
||||
<listitem>
|
||||
<para>for taking over as project lead when Tara stepped down and
|
||||
continually pushing for the documentation to be the best it can be.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
|
||||
<para>
|
||||
Thanks also go to the following people for significant contributions
|
||||
to this documentation:
|
||||
<simplelist type="inline">
|
||||
<member>Kevin Brannen</member>
|
||||
<member>Vlad Dascalu</member>
|
||||
<member>Ben FrantzDale</member>
|
||||
<member>Eric Hanson</member>
|
||||
<member>Zach Lipton</member>
|
||||
<member>Gervase Markham</member>
|
||||
<member>Andrew Pearson</member>
|
||||
<member>Joe Robins</member>
|
||||
<member>Spencer Smith</member>
|
||||
<member>Ron Teitelbaum</member>
|
||||
<member>Shane Travis</member>
|
||||
<member>Martin Wulffeld</member>
|
||||
</simplelist>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Also, thanks are due to the members of the
|
||||
<ulink url="news://news.mozilla.org/mozilla.support.bugzilla">
|
||||
mozilla.support.bugzilla</ulink>
|
||||
newsgroup (and its predecessor, netscape.public.mozilla.webtools).
|
||||
Without your discussions, insight, suggestions, and patches,
|
||||
this could never have happened.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<!-- conventions used here (didn't want to give it a chapter of its own) -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="conventions.xml" />
|
||||
</chapter>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End: -->
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,168 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<section id="conventions">
|
||||
<title>Document Conventions</title>
|
||||
|
||||
<indexterm zone="conventions">
|
||||
<primary>conventions</primary>
|
||||
</indexterm>
|
||||
|
||||
<para>This document uses the following conventions:</para>
|
||||
|
||||
<informaltable frame="none">
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Descriptions</entry>
|
||||
|
||||
<entry>Appearance</entry>
|
||||
</row>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>Caution</entry>
|
||||
|
||||
<entry>
|
||||
<caution>
|
||||
<para>Don't run with scissors!</para>
|
||||
</caution>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Hint or Tip</entry>
|
||||
|
||||
<entry>
|
||||
<tip>
|
||||
<para>For best results... </para>
|
||||
</tip>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Note</entry>
|
||||
|
||||
<entry>
|
||||
<note>
|
||||
<para>Dear John...</para>
|
||||
</note>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Warning</entry>
|
||||
|
||||
<entry>
|
||||
<warning>
|
||||
<para>Read this or the cat gets it.</para>
|
||||
</warning>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>File or directory name</entry>
|
||||
|
||||
<entry>
|
||||
<filename>filename</filename>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Command to be typed</entry>
|
||||
|
||||
<entry>
|
||||
<command>command</command>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Application name</entry>
|
||||
|
||||
<entry>
|
||||
<application>application</application>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>
|
||||
Normal user's prompt under bash shell</entry>
|
||||
|
||||
<entry>bash$</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>
|
||||
Root user's prompt under bash shell</entry>
|
||||
|
||||
<entry>bash#</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>
|
||||
Normal user's prompt under tcsh shell</entry>
|
||||
|
||||
<entry>tcsh$</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Environment variables</entry>
|
||||
|
||||
<entry>
|
||||
<envar>VARIABLE</envar>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Term found in the glossary</entry>
|
||||
|
||||
<entry>
|
||||
<glossterm linkend="gloss-bugzilla">Bugzilla</glossterm>
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Code example</entry>
|
||||
|
||||
<entry>
|
||||
<programlisting><sgmltag class="starttag">para</sgmltag>
|
||||
Beginning and end of paragraph
|
||||
<sgmltag class="endtag">para</sgmltag></programlisting>
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
|
||||
<para>
|
||||
This documentation is maintained in DocBook 4.1.2 XML format.
|
||||
Changes are best submitted as plain text or XML diffs, attached
|
||||
to a bug filed in the &bzg-bugs; component.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,821 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<chapter id="customization">
|
||||
<title>Customizing Bugzilla</title>
|
||||
|
||||
<section id="cust-skins">
|
||||
<title>Custom Skins</title>
|
||||
|
||||
<para>
|
||||
Bugzilla allows you to have multiple skins. These are custom CSS and possibly
|
||||
also custom images for Bugzilla. To create a new custom skin, you have two
|
||||
choices:
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Make a single CSS file, and put it in the
|
||||
<filename>skins/contrib</filename> directory.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Make a directory that contains all the same CSS file
|
||||
names as <filename>skins/standard/</filename>, and put
|
||||
your directory in <filename>skins/contrib/</filename>.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
After you put the file or the directory there, make sure to run checksetup.pl
|
||||
so that it can reset the file permissions correctly.
|
||||
</para>
|
||||
<para>
|
||||
After you have installed the new skin, it will show up as an option in the
|
||||
user's General Preferences. If you would like to force a particular skin on all
|
||||
users, just select it in the Default Preferences and then uncheck "Enabled" on
|
||||
the preference.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="cust-templates">
|
||||
<title>Template Customization</title>
|
||||
|
||||
<para>
|
||||
Administrators can configure the look and feel of Bugzilla without
|
||||
having to edit Perl files or face the nightmare of massive merge
|
||||
conflicts when they upgrade to a newer version in the future.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Templatization also makes localized versions of Bugzilla possible,
|
||||
for the first time. It's possible to have Bugzilla's UI language
|
||||
determined by the user's browser. More information is available in
|
||||
<xref linkend="template-http-accept"/>.
|
||||
</para>
|
||||
|
||||
<section id="template-directory">
|
||||
<title>Template Directory Structure</title>
|
||||
<para>
|
||||
The template directory structure starts with top level directory
|
||||
named <filename>template</filename>, which contains a directory
|
||||
for each installed localization. The next level defines the
|
||||
language used in the templates. Bugzilla comes with English
|
||||
templates, so the directory name is <filename>en</filename>,
|
||||
and we will discuss <filename>template/en</filename> throughout
|
||||
the documentation. Below <filename>template/en</filename> is the
|
||||
<filename>default</filename> directory, which contains all the
|
||||
standard templates shipped with Bugzilla.
|
||||
</para>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
A directory <filename>data/templates</filename> also exists;
|
||||
this is where Template Toolkit puts the compiled versions of
|
||||
the templates from either the default or custom directories.
|
||||
<emphasis>Do not</emphasis> directly edit the files in this
|
||||
directory, or all your changes will be lost the next time
|
||||
Template Toolkit recompiles the templates.
|
||||
</para>
|
||||
</warning>
|
||||
</section>
|
||||
|
||||
<section id="template-method">
|
||||
<title>Choosing a Customization Method</title>
|
||||
<para>
|
||||
If you want to edit Bugzilla's templates, the first decision
|
||||
you must make is how you want to go about doing so. There are two
|
||||
choices, and which you use depends mainly on the scope of your
|
||||
modifications, and the method you plan to use to upgrade Bugzilla.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The first method of making customizations is to directly edit the
|
||||
templates found in <filename>template/en/default</filename>.
|
||||
This is probably the best way to go about it if you are going to
|
||||
be upgrading Bugzilla through CVS, because if you then execute
|
||||
a <command>cvs update</command>, any changes you have made will
|
||||
be merged automagically with the updated versions.
|
||||
</para>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
If you use this method, and CVS conflicts occur during an
|
||||
update, the conflicted templates (and possibly other parts
|
||||
of your installation) will not work until they are resolved.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
The second method is to copy the templates to be modified
|
||||
into a mirrored directory structure under
|
||||
<filename>template/en/custom</filename>. Templates in this
|
||||
directory structure automatically override any identically-named
|
||||
and identically-located templates in the
|
||||
<filename>default</filename> directory.
|
||||
</para>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
The <filename>custom</filename> directory does not exist
|
||||
at first and must be created if you want to use it.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
The second method of customization should be used if you
|
||||
use the overwriting method of upgrade, because otherwise
|
||||
your changes will be lost. This method may also be better if
|
||||
you are using the CVS method of upgrading and are going to make major
|
||||
changes, because it is guaranteed that the contents of this directory
|
||||
will not be touched during an upgrade, and you can then decide whether
|
||||
to continue using your own templates, or make the effort to merge your
|
||||
changes into the new versions by hand.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Using this method, your installation may break if incompatible
|
||||
changes are made to the template interface. Such changes should
|
||||
be documented in the release notes, provided you are using a
|
||||
stable release of Bugzilla. If you use using unstable code, you will
|
||||
need to deal with this one yourself, although if possible the changes
|
||||
will be mentioned before they occur in the deprecations section of the
|
||||
previous stable release's release notes.
|
||||
</para>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
Regardless of which method you choose, it is recommended that
|
||||
you run <command>./checksetup.pl</command> after creating or
|
||||
editing any templates in the <filename>template/en/default</filename>
|
||||
directory, and after editing any templates in the
|
||||
<filename>custom</filename> directory.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
It is <emphasis>required</emphasis> that you run
|
||||
<command>./checksetup.pl</command> after creating a new
|
||||
template in the <filename>custom</filename> directory. Failure
|
||||
to do so will raise an incomprehensible error message.
|
||||
</para>
|
||||
</warning>
|
||||
</section>
|
||||
|
||||
<section id="template-edit">
|
||||
<title>How To Edit Templates</title>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
If you are making template changes that you intend on submitting back
|
||||
for inclusion in standard Bugzilla, you should read the relevant
|
||||
sections of the
|
||||
<ulink url="http://www.bugzilla.org/docs/developer.html">Developers'
|
||||
Guide</ulink>.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
The syntax of the Template Toolkit language is beyond the scope of
|
||||
this guide. It's reasonably easy to pick up by looking at the current
|
||||
templates; or, you can read the manual, available on the
|
||||
<ulink url="http://www.template-toolkit.org">Template Toolkit home
|
||||
page</ulink>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
One thing you should take particular care about is the need
|
||||
to properly HTML filter data that has been passed into the template.
|
||||
This means that if the data can possibly contain special HTML characters
|
||||
such as <, and the data was not intended to be HTML, they need to be
|
||||
converted to entity form, i.e. &lt;. You use the 'html' filter in the
|
||||
Template Toolkit to do this. If you forget, you may open up
|
||||
your installation to cross-site scripting attacks.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Also note that Bugzilla adds a few filters of its own, that are not
|
||||
in standard Template Toolkit. In particular, the 'url_quote' filter
|
||||
can convert characters that are illegal or have special meaning in URLs,
|
||||
such as &, to the encoded form, i.e. %26. This actually encodes most
|
||||
characters (but not the common ones such as letters and numbers and so
|
||||
on), including the HTML-special characters, so there's never a need to
|
||||
HTML filter afterwards.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Editing templates is a good way of doing a <quote>poor man's custom
|
||||
fields</quote>.
|
||||
For example, if you don't use the Status Whiteboard, but want to have
|
||||
a free-form text entry box for <quote>Build Identifier</quote>,
|
||||
then you can just
|
||||
edit the templates to change the field labels. It's still be called
|
||||
status_whiteboard internally, but your users don't need to know that.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="template-formats">
|
||||
<title>Template Formats and Types</title>
|
||||
|
||||
<para>
|
||||
Some CGI's have the ability to use more than one template. For example,
|
||||
<filename>buglist.cgi</filename> can output itself as RDF, or as two
|
||||
formats of HTML (complex and simple). The mechanism that provides this
|
||||
feature is extensible.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Bugzilla can support different types of output, which again can have
|
||||
multiple formats. In order to request a certain type, you can append
|
||||
the &ctype=<contenttype> (such as rdf or html) to the
|
||||
<filename><cginame>.cgi</filename> URL. If you would like to
|
||||
retrieve a certain format, you can use the &format=<format>
|
||||
(such as simple or complex) in the URL.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To see if a CGI supports multiple output formats and types, grep the
|
||||
CGI for <quote>get_format</quote>. If it's not present, adding
|
||||
multiple format/type support isn't too hard - see how it's done in
|
||||
other CGIs, e.g. config.cgi.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To make a new format template for a CGI which supports this,
|
||||
open a current template for
|
||||
that CGI and take note of the INTERFACE comment (if present.) This
|
||||
comment defines what variables are passed into this template. If
|
||||
there isn't one, I'm afraid you'll have to read the template and
|
||||
the code to find out what information you get.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Write your template in whatever markup or text style is appropriate.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You now need to decide what content type you want your template
|
||||
served as. The content types are defined in the
|
||||
<filename>Bugzilla/Constants.pm</filename> file in the
|
||||
<filename>contenttypes</filename>
|
||||
constant. If your content type is not there, add it. Remember
|
||||
the three- or four-letter tag assigned to your content type.
|
||||
This tag will be part of the template filename.
|
||||
</para>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
After adding or changing a content type, it's suitable to edit
|
||||
<filename>Bugzilla/Constants.pm</filename> in order to reflect
|
||||
the changes. Also, the file should be kept up to date after an
|
||||
upgrade if content types have been customized in the past.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
Save the template as <filename><stubname>-<formatname>.<contenttypetag>.tmpl</filename>.
|
||||
Try out the template by calling the CGI as
|
||||
<filename><cginame>.cgi?format=<formatname>&ctype=<type></filename> .
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
||||
<section id="template-specific">
|
||||
<title>Particular Templates</title>
|
||||
|
||||
<para>
|
||||
There are a few templates you may be particularly interested in
|
||||
customizing for your installation.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>index.html.tmpl</command>:
|
||||
This is the Bugzilla front page.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>global/header.html.tmpl</command>:
|
||||
This defines the header that goes on all Bugzilla pages.
|
||||
The header includes the banner, which is what appears to users
|
||||
and is probably what you want to edit instead. However the
|
||||
header also includes the HTML HEAD section, so you could for
|
||||
example add a stylesheet or META tag by editing the header.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>global/banner.html.tmpl</command>:
|
||||
This contains the <quote>banner</quote>, the part of the header
|
||||
that appears
|
||||
at the top of all Bugzilla pages. The default banner is reasonably
|
||||
barren, so you'll probably want to customize this to give your
|
||||
installation a distinctive look and feel. It is recommended you
|
||||
preserve the Bugzilla version number in some form so the version
|
||||
you are running can be determined, and users know what docs to read.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>global/footer.html.tmpl</command>:
|
||||
This defines the footer that goes on all Bugzilla pages. Editing
|
||||
this is another way to quickly get a distinctive look and feel for
|
||||
your Bugzilla installation.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>global/variables.none.tmpl</command>:
|
||||
This defines a list of terms that may be changed in order to
|
||||
<quote>brand</quote> the Bugzilla instance In this way, terms
|
||||
like <quote>bugs</quote> can be replaced with <quote>issues</quote>
|
||||
across the whole Bugzilla installation. The name
|
||||
<quote>Bugzilla</quote> and other words can be customized as well.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>list/table.html.tmpl</command>:
|
||||
This template controls the appearance of the bug lists created
|
||||
by Bugzilla. Editing this template allows per-column control of
|
||||
the width and title of a column, the maximum display length of
|
||||
each entry, and the wrap behaviour of long entries.
|
||||
For long bug lists, Bugzilla inserts a 'break' every 100 bugs by
|
||||
default; this behaviour is also controlled by this template, and
|
||||
that value can be modified here.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>bug/create/user-message.html.tmpl</command>:
|
||||
This is a message that appears near the top of the bug reporting page.
|
||||
By modifying this, you can tell your users how they should report
|
||||
bugs.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>bug/process/midair.html.tmpl</command>:
|
||||
This is the page used if two people submit simultaneous changes to the
|
||||
same bug. The second person to submit their changes will get this page
|
||||
to tell them what the first person did, and ask if they wish to
|
||||
overwrite those changes or go back and revisit the bug. The default
|
||||
title and header on this page read "Mid-air collision detected!" If
|
||||
you work in the aviation industry, or other environment where this
|
||||
might be found offensive (yes, we have true stories of this happening)
|
||||
you'll want to change this to something more appropriate for your
|
||||
environment.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>bug/create/create.html.tmpl</command> and
|
||||
<command>bug/create/comment.txt.tmpl</command>:
|
||||
You may not wish to go to the effort of creating custom fields in
|
||||
Bugzilla, yet you want to make sure that each bug report contains
|
||||
a number of pieces of important information for which there is not
|
||||
a special field. The bug entry system has been designed in an
|
||||
extensible fashion to enable you to add arbitrary HTML widgets,
|
||||
such as drop-down lists or textboxes, to the bug entry page
|
||||
and have their values appear formatted in the initial comment.
|
||||
A hidden field that indicates the format should be added inside
|
||||
the form in order to make the template functional. Its value should
|
||||
be the suffix of the template filename. For example, if the file
|
||||
is called <filename>create-cust.html.tmpl</filename>, then
|
||||
<programlisting><input type="hidden" name="format" value="cust"></programlisting>
|
||||
should be used inside the form.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
An example of this is the mozilla.org
|
||||
<ulink url="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi?product=WorldControl&format=guided">guided
|
||||
bug submission form</ulink>. The code for this comes with the Bugzilla
|
||||
distribution as an example for you to copy. It can be found in the
|
||||
files
|
||||
<filename>create-guided.html.tmpl</filename> and
|
||||
<filename>comment-guided.html.tmpl</filename>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
So to use this feature, create a custom template for
|
||||
<filename>enter_bug.cgi</filename>. The default template, on which you
|
||||
could base it, is
|
||||
<filename>custom/bug/create/create.html.tmpl</filename>.
|
||||
Call it <filename>create-<formatname>.html.tmpl</filename>, and
|
||||
in it, add widgets for each piece of information you'd like
|
||||
collected - such as a build number, or set of steps to reproduce.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Then, create a template like
|
||||
<filename>custom/bug/create/comment.txt.tmpl</filename>, and call it
|
||||
<filename>comment-<formatname>.txt.tmpl</filename>. This
|
||||
template should reference the form fields you have created using
|
||||
the syntax <filename>[% form.<fieldname> %]</filename>. When a
|
||||
bug report is
|
||||
submitted, the initial comment attached to the bug report will be
|
||||
formatted according to the layout of this template.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For example, if your custom enter_bug template had a field
|
||||
<programlisting><input type="text" name="buildid" size="30"></programlisting>
|
||||
and then your comment.txt.tmpl had
|
||||
<programlisting>BuildID: [% form.buildid %]</programlisting>
|
||||
then something like
|
||||
<programlisting>BuildID: 20020303</programlisting>
|
||||
would appear in the initial comment.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
||||
<section id="template-http-accept">
|
||||
<title>Configuring Bugzilla to Detect the User's Language</title>
|
||||
|
||||
<para>Bugzilla honours the user's Accept: HTTP header. You can install
|
||||
templates in other languages, and Bugzilla will pick the most appropriate
|
||||
according to a priority order defined by you. Many
|
||||
language templates can be obtained from <ulink
|
||||
url="http://www.bugzilla.org/download.html#localizations"/>. Instructions
|
||||
for submitting new languages are also available from that location.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="cust-hooks">
|
||||
<title>The Bugzilla Extension Mechanism</title>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
Note that the below paths are inconsistent and confusing. They will
|
||||
likely be changed in Bugzilla 4.0.
|
||||
</para>
|
||||
</warning>
|
||||
|
||||
<para>
|
||||
Extensions are a way for extensions to Bugzilla to insert code
|
||||
into the standard Bugzilla templates and source files
|
||||
without modifying these files themselves. The extension mechanism
|
||||
defines a consistent API for extending the standard templates and source files
|
||||
in a way that cleanly separates standard code from extension code.
|
||||
Hooks reduce merge conflicts and make it easier to write extensions that work
|
||||
across multiple versions of Bugzilla, making upgrading a Bugzilla installation
|
||||
with installed extensions easier. Furthermore, they make it easy to install
|
||||
and remove extensions as each extension is nothing more than a
|
||||
simple directory structure.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
There are two main types of hooks: code hooks and template hooks. Code
|
||||
hooks allow extensions to invoke code at specific points in various
|
||||
source files, while template hooks allow extensions to add elements to
|
||||
the Bugzilla user interface.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
A hook is just a named place in a standard source or template file
|
||||
where extension source code or template files for that hook get processed.
|
||||
Each extension has a corresponding directory in the Bugzilla directory
|
||||
tree (<filename>BUGZILLA_ROOT/extensions/extension_name</filename>). Hooking
|
||||
an extension source file or template to a hook is as simple as putting
|
||||
the extension file into extension's template or code directory.
|
||||
When Bugzilla processes the source file or template and reaches the hook,
|
||||
it will process all extension files in the hook's directory.
|
||||
The hooks themselves can be added into any source file or standard template
|
||||
upon request by extension authors.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To use hooks to extend Bugzilla, first make sure there is
|
||||
a hook at the appropriate place within the source file or template you
|
||||
want to extend. The exact appearance of a hook depends on if the hook
|
||||
is a code hook or a template hook.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Code hooks appear in Bugzilla source files as a single method call
|
||||
in the format <literal role="code">Bugzilla::Hook->process("<varname>name</varname>");</literal>.
|
||||
For instance, <filename>enter_bug.cgi</filename> may invoke the hook
|
||||
"<varname>enter_bug-entrydefaultvars</varname>". Thus, a source file at
|
||||
<filename>BUGZILLA_ROOT/extensions/EXTENSION_NAME/code/enter_bug-entrydefaultvars.pl</filename>
|
||||
will be automatically invoked when the code hook is reached.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Template hooks appear in the standard Bugzilla templates as a
|
||||
single directive in the format
|
||||
<literal role="code">[% Hook.process("<varname>name</varname>") %]</literal>,
|
||||
where <varname>name</varname> is the unique name of the hook.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If you aren't sure what you want to extend or just want to browse the
|
||||
available hooks, either use your favorite multi-file search
|
||||
tool (e.g. <command>grep</command>) to search the standard templates
|
||||
for occurrences of <methodname>Hook.process</methodname> or the source
|
||||
files for occurrences of <methodname>Bugzilla::Hook::process</methodname>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If there is no hook at the appropriate place within the Bugzilla
|
||||
source file or template you want to extend,
|
||||
<ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=User%20Interface">file
|
||||
a bug requesting one</ulink>, specifying:
|
||||
</para>
|
||||
|
||||
<simplelist>
|
||||
<member>the source or template file for which you are
|
||||
requesting a hook;</member>
|
||||
<member>
|
||||
where in the file you would like the hook to be placed
|
||||
(line number/position for latest version of the file in CVS
|
||||
or description of location);
|
||||
</member>
|
||||
<member>the purpose of the hook;</member>
|
||||
<member>a link to information about your extension, if any.</member>
|
||||
</simplelist>
|
||||
|
||||
<para>
|
||||
The Bugzilla reviewers will promptly review each hook request,
|
||||
name the hook, add it to the template or source file, and check
|
||||
the new version of the template into CVS.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You may optionally attach a patch to the bug which implements the hook
|
||||
and check it in yourself after receiving approval from a Bugzilla
|
||||
reviewer. The developers may suggest changes to the location of the
|
||||
hook based on their analysis of your needs or so the hook can satisfy
|
||||
the needs of multiple extensions, but the process of getting hooks
|
||||
approved and checked in is not as stringent as the process for general
|
||||
changes to Bugzilla, and any extension, whether released or still in
|
||||
development, can have hooks added to meet their needs.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
After making sure the hook you need exists (or getting it added if not),
|
||||
add your extension to the directory within the Bugzilla
|
||||
extensions tree corresponding to the hook.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
That's it! Now, when the source file or template containing the hook
|
||||
is processed, your extension file will be processed at the point
|
||||
where the hook appears.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For example, let's say you have an extension named Projman that adds
|
||||
project management capabilities to Bugzilla. Projman has an
|
||||
administration interface <filename>edit-projects.cgi</filename>,
|
||||
and you want to add a link to it into the navigation bar at the bottom
|
||||
of every Bugzilla page for those users who are authorized
|
||||
to administer projects.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The navigation bar is generated by the template file
|
||||
<filename>useful-links.html.tmpl</filename>, which is located in
|
||||
the <filename>global/</filename> subdirectory on the standard Bugzilla
|
||||
template path
|
||||
<filename>BUGZILLA_ROOT/template/en/default/</filename>.
|
||||
Looking in <filename>useful-links.html.tmpl</filename>, you find
|
||||
the following hook at the end of the list of standard Bugzilla
|
||||
administration links:
|
||||
</para>
|
||||
|
||||
<programlisting><![CDATA[...
|
||||
[% ', <a href="editkeywords.cgi">keywords</a>'
|
||||
IF user.groups.editkeywords %]
|
||||
[% Hook.process("edit") %]
|
||||
...]]></programlisting>
|
||||
|
||||
<para>
|
||||
The corresponding extension file for this hook is
|
||||
<filename>BUGZILLA_ROOT/extensions/projman/template/en/global/useful-links-edit.html.tmpl</filename>.
|
||||
You then create that template file and add the following constant:
|
||||
</para>
|
||||
|
||||
<programlisting><![CDATA[...[% ', <a href="edit-projects.cgi">projects</a>' IF user.groups.projman_admins %]]]></programlisting>
|
||||
|
||||
<para>
|
||||
Voila! The link now appears after the other administration links in the
|
||||
navigation bar for users in the <literal>projman_admins</literal> group.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Now, let us say your extension adds a custom "project_manager" field
|
||||
to enter_bug.cgi. You want to modify the CGI script to set the default
|
||||
project manager to be productname@company.com. Looking at
|
||||
<filename>enter_bug.cgi</filename>, you see the enter_bug-entrydefaultvars
|
||||
hook near the bottom of the file before the default form values are set.
|
||||
The corresponding extension source file for this hook is located at
|
||||
<filename>BUGZILLA_ROOT/extensions/projman/code/enter_bug-entrydefaultvars.pl</filename>.
|
||||
You then create that file and add the following:
|
||||
</para>
|
||||
|
||||
<programlisting>$default{'project_manager'} = $product.'@company.com';</programlisting>
|
||||
|
||||
<para>
|
||||
This code will be invoked whenever enter_bug.cgi is executed.
|
||||
Assuming that the rest of the customization was completed (e.g. the
|
||||
custom field was added to the enter_bug template and the required hooks
|
||||
were used in process_bug.cgi), the new field will now have this
|
||||
default value.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Notes:
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
If your extension includes entirely new templates in addition to
|
||||
extensions of standard templates, it should store those new
|
||||
templates in its
|
||||
<filename>BUGZILLA_ROOT/extensions/template/en/</filename>
|
||||
directory. Extension template directories, like the
|
||||
<filename>default/</filename> and <filename>custom/</filename>
|
||||
directories, are part of the template search path, so putting templates
|
||||
there enables them to be found by the template processor.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The template processor looks for templates first in the
|
||||
<filename>custom/</filename> directory (i.e. templates added by the
|
||||
specific installation), then in the <filename>extensions/</filename>
|
||||
directory (i.e. templates added by extensions), and finally in the
|
||||
<filename>default/</filename> directory (i.e. the standard Bugzilla
|
||||
templates). Thus, installation-specific templates override both
|
||||
default and extension templates.
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>
|
||||
If you are looking to customize Bugzilla, you can also take advantage
|
||||
of template hooks. To do so, create a directory in
|
||||
<filename>BUGZILLA_ROOT/template/en/custom/hook/</filename>
|
||||
that corresponds to the hook you wish to use, then place your
|
||||
customization templates into those directories. For example,
|
||||
if you wanted to use the hook "end" in
|
||||
<filename>global/useful-links.html.tmpl</filename>, you would
|
||||
create the directory <filename>BUGZILLA_ROOT/template/en/custom/hook/
|
||||
global/useful-links.html.tmpl/end/</filename> and add your customization
|
||||
template to this directory.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Obviously this method of customizing Bugzilla only lets you add code
|
||||
to the standard source files and templates; you cannot change the
|
||||
existing code. Nevertheless, for those customizations that only add
|
||||
code, this method can reduce conflicts when merging changes,
|
||||
making upgrading your customized Bugzilla installation easier.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
|
||||
<section id="cust-change-permissions">
|
||||
<title>Customizing Who Can Change What</title>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
This feature should be considered experimental; the Bugzilla code you
|
||||
will be changing is not stable, and could change or move between
|
||||
versions. Be aware that if you make modifications as outlined here,
|
||||
you may have
|
||||
to re-make them or port them if Bugzilla changes internally between
|
||||
versions, and you upgrade.
|
||||
</para>
|
||||
</warning>
|
||||
|
||||
<para>
|
||||
Companies often have rules about which employees, or classes of employees,
|
||||
are allowed to change certain things in the bug system. For example,
|
||||
only the bug's designated QA Contact may be allowed to VERIFY the bug.
|
||||
Bugzilla has been
|
||||
designed to make it easy for you to write your own custom rules to define
|
||||
who is allowed to make what sorts of value transition.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
By default, assignees, QA owners and users
|
||||
with <emphasis>editbugs</emphasis> privileges can edit all fields of bugs,
|
||||
except group restrictions (unless they are members of the groups they
|
||||
are trying to change). Bug reporters also have the ability to edit some
|
||||
fields, but in a more restrictive manner. Other users, without
|
||||
<emphasis>editbugs</emphasis> privileges, can not edit
|
||||
bugs, except to comment and add themselves to the CC list.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For maximum flexibility, customizing this means editing Bugzilla's Perl
|
||||
code. This gives the administrator complete control over exactly who is
|
||||
allowed to do what. The relevant method is called
|
||||
<filename>check_can_change_field()</filename>,
|
||||
and is found in <filename>Bug.pm</filename> in your
|
||||
Bugzilla/ directory. If you open that file and search for
|
||||
<quote>sub check_can_change_field</quote>, you'll find it.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
This function has been carefully commented to allow you to see exactly
|
||||
how it works, and give you an idea of how to make changes to it.
|
||||
Certain marked sections should not be changed - these are
|
||||
the <quote>plumbing</quote> which makes the rest of the function work.
|
||||
In between those sections, you'll find snippets of code like:
|
||||
<programlisting> # Allow the assignee to change anything.
|
||||
if ($ownerid eq $whoid) {
|
||||
return 1;
|
||||
}</programlisting>
|
||||
It's fairly obvious what this piece of code does.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
So, how does one go about changing this function? Well, simple changes
|
||||
can be made just by removing pieces - for example, if you wanted to
|
||||
prevent any user adding a comment to a bug, just remove the lines marked
|
||||
<quote>Allow anyone to change comments.</quote> If you don't want the
|
||||
Reporter to have any special rights on bugs they have filed, just
|
||||
remove the entire section that deals with the Reporter.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
More complex customizations are not much harder. Basically, you add
|
||||
a check in the right place in the function, i.e. after all the variables
|
||||
you are using have been set up. So, don't look at $ownerid before
|
||||
$ownerid has been obtained from the database. You can either add a
|
||||
positive check, which returns 1 (allow) if certain conditions are true,
|
||||
or a negative check, which returns 0 (deny.) E.g.:
|
||||
<programlisting> if ($field eq "qacontact") {
|
||||
if (Bugzilla->user->groups("quality_assurance")) {
|
||||
return 1;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
}
|
||||
}</programlisting>
|
||||
This says that only users in the group "quality_assurance" can change
|
||||
the QA Contact field of a bug.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Getting more weird:
|
||||
<programlisting><![CDATA[ if (($field eq "priority") &&
|
||||
(Bugzilla->user->email =~ /.*\@example\.com$/))
|
||||
{
|
||||
if ($oldvalue eq "P1") {
|
||||
return 1;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
}
|
||||
}]]></programlisting>
|
||||
This says that if the user is trying to change the priority field,
|
||||
and their email address is @example.com, they can only do so if the
|
||||
old value of the field was "P1". Not very useful, but illustrative.
|
||||
</para>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
If you are modifying <filename>process_bug.cgi</filename> in any
|
||||
way, do not change the code that is bounded by DO_NOT_CHANGE blocks.
|
||||
Doing so could compromise security, or cause your installation to
|
||||
stop working entirely.
|
||||
</para>
|
||||
</warning>
|
||||
|
||||
<para>
|
||||
For a list of possible field names, look at the bugs table in the
|
||||
database. If you need help writing custom rules for your organization,
|
||||
ask in the newsgroup.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<!-- Integrating Bugzilla with Third-Party Tools -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="integration.xml" />
|
||||
</chapter>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,449 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<appendix id="gfdl">
|
||||
<title>GNU Free Documentation License</title>
|
||||
|
||||
<!-- - GNU Project - Free Software Foundation (FSF) -->
|
||||
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
|
||||
<!-- section>
|
||||
<title>GNU Free Documentation License</title -->
|
||||
<para>Version 1.1, March 2000</para>
|
||||
|
||||
<blockquote>
|
||||
<para>Copyright (C) 2000 Free Software Foundation, Inc. 59 Temple Place,
|
||||
Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and
|
||||
distribute verbatim copies of this license document, but changing it is
|
||||
not allowed.</para>
|
||||
</blockquote>
|
||||
|
||||
<section label="0" id="gfdl-0">
|
||||
<title>Preamble</title>
|
||||
|
||||
<para>The purpose of this License is to make a manual, textbook, or other
|
||||
written document "free" in the sense of freedom: to assure everyone the
|
||||
effective freedom to copy and redistribute it, with or without modifying
|
||||
it, either commercially or noncommercially. Secondarily, this License
|
||||
preserves for the author and publisher a way to get credit for their
|
||||
work, while not being considered responsible for modifications made by
|
||||
others.</para>
|
||||
|
||||
<para>This License is a kind of "copyleft", which means that derivative
|
||||
works of the document must themselves be free in the same sense. It
|
||||
complements the GNU General Public License, which is a copyleft license
|
||||
designed for free software.</para>
|
||||
|
||||
<para>We have designed this License in order to use it for manuals for
|
||||
free software, because free software needs free documentation: a free
|
||||
program should come with manuals providing the same freedoms that the
|
||||
software does. But this License is not limited to software manuals; it
|
||||
can be used for any textual work, regardless of subject matter or whether
|
||||
it is published as a printed book. We recommend this License principally
|
||||
for works whose purpose is instruction or reference.</para>
|
||||
</section>
|
||||
|
||||
<section label="1" id="gfdl-1">
|
||||
<title>Applicability and Definition</title>
|
||||
|
||||
<para>This License applies to any manual or other work that contains a
|
||||
notice placed by the copyright holder saying it can be distributed under
|
||||
the terms of this License. The "Document", below, refers to any such
|
||||
manual or work. Any member of the public is a licensee, and is addressed
|
||||
as "you".</para>
|
||||
|
||||
<para>A "Modified Version" of the Document means any work containing the
|
||||
Document or a portion of it, either copied verbatim, or with
|
||||
modifications and/or translated into another language.</para>
|
||||
|
||||
<para>A "Secondary Section" is a named appendix or a front-matter section
|
||||
of the Document that deals exclusively with the relationship of the
|
||||
publishers or authors of the Document to the Document's overall subject
|
||||
(or to related matters) and contains nothing that could fall directly
|
||||
within that overall subject. (For example, if the Document is in part a
|
||||
textbook of mathematics, a Secondary Section may not explain any
|
||||
mathematics.) The relationship could be a matter of historical connection
|
||||
with the subject or with related matters, or of legal, commercial,
|
||||
philosophical, ethical or political position regarding them.</para>
|
||||
|
||||
<para>The "Invariant Sections" are certain Secondary Sections whose
|
||||
titles are designated, as being those of Invariant Sections, in the
|
||||
notice that says that the Document is released under this License.</para>
|
||||
|
||||
<para>The "Cover Texts" are certain short passages of text that are
|
||||
listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says
|
||||
that the Document is released under this License.</para>
|
||||
|
||||
<para>A "Transparent" copy of the Document means a machine-readable copy,
|
||||
represented in a format whose specification is available to the general
|
||||
public, whose contents can be viewed and edited directly and
|
||||
straightforwardly with generic text editors or (for images composed of
|
||||
pixels) generic paint programs or (for drawings) some widely available
|
||||
drawing editor, and that is suitable for input to text formatters or for
|
||||
automatic translation to a variety of formats suitable for input to text
|
||||
formatters. A copy made in an otherwise Transparent file format whose
|
||||
markup has been designed to thwart or discourage subsequent modification
|
||||
by readers is not Transparent. A copy that is not "Transparent" is called
|
||||
"Opaque".</para>
|
||||
|
||||
<para>Examples of suitable formats for Transparent copies include plain
|
||||
ASCII without markup, Texinfo input format, LaTeX input format, SGML or
|
||||
XML using a publicly available DTD, and standard-conforming simple HTML
|
||||
designed for human modification. Opaque formats include PostScript, PDF,
|
||||
proprietary formats that can be read and edited only by proprietary word
|
||||
processors, SGML or XML for which the DTD and/or processing tools are not
|
||||
generally available, and the machine-generated HTML produced by some word
|
||||
processors for output purposes only.</para>
|
||||
|
||||
<para>The "Title Page" means, for a printed book, the title page itself,
|
||||
plus such following pages as are needed to hold, legibly, the material
|
||||
this License requires to appear in the title page. For works in formats
|
||||
which do not have any title page as such, "Title Page" means the text
|
||||
near the most prominent appearance of the work's title, preceding the
|
||||
beginning of the body of the text.</para>
|
||||
</section>
|
||||
|
||||
<section label="2" id="gfdl-2">
|
||||
<title>Verbatim Copying</title>
|
||||
|
||||
<para>You may copy and distribute the Document in any medium, either
|
||||
commercially or noncommercially, provided that this License, the
|
||||
copyright notices, and the license notice saying this License applies to
|
||||
the Document are reproduced in all copies, and that you add no other
|
||||
conditions whatsoever to those of this License. You may not use technical
|
||||
measures to obstruct or control the reading or further copying of the
|
||||
copies you make or distribute. However, you may accept compensation in
|
||||
exchange for copies. If you distribute a large enough number of copies
|
||||
you must also follow the conditions in section 3.</para>
|
||||
|
||||
<para>You may also lend copies, under the same conditions stated above,
|
||||
and you may publicly display copies.</para>
|
||||
</section>
|
||||
|
||||
<section label="3" id="gfdl-3">
|
||||
<title>Copying in Quantity</title>
|
||||
|
||||
<para>If you publish printed copies of the Document numbering more than
|
||||
100, and the Document's license notice requires Cover Texts, you must
|
||||
enclose the copies in covers that carry, clearly and legibly, all these
|
||||
Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts
|
||||
on the back cover. Both covers must also clearly and legibly identify you
|
||||
as the publisher of these copies. The front cover must present the full
|
||||
title with all words of the title equally prominent and visible. You may
|
||||
add other material on the covers in addition. Copying with changes
|
||||
limited to the covers, as long as they preserve the title of the Document
|
||||
and satisfy these conditions, can be treated as verbatim copying in other
|
||||
respects.</para>
|
||||
|
||||
<para>If the required texts for either cover are too voluminous to fit
|
||||
legibly, you should put the first ones listed (as many as fit reasonably)
|
||||
on the actual cover, and continue the rest onto adjacent pages.</para>
|
||||
|
||||
<para>If you publish or distribute Opaque copies of the Document
|
||||
numbering more than 100, you must either include a machine-readable
|
||||
Transparent copy along with each Opaque copy, or state in or with each
|
||||
Opaque copy a publicly-accessible computer-network location containing a
|
||||
complete Transparent copy of the Document, free of added material, which
|
||||
the general network-using public has access to download anonymously at no
|
||||
charge using public-standard network protocols. If you use the latter
|
||||
option, you must take reasonably prudent steps, when you begin
|
||||
distribution of Opaque copies in quantity, to ensure that this
|
||||
Transparent copy will remain thus accessible at the stated location until
|
||||
at least one year after the last time you distribute an Opaque copy
|
||||
(directly or through your agents or retailers) of that edition to the
|
||||
public.</para>
|
||||
|
||||
<para>It is requested, but not required, that you contact the authors of
|
||||
the Document well before redistributing any large number of copies, to
|
||||
give them a chance to provide you with an updated version of the
|
||||
Document.</para>
|
||||
</section>
|
||||
|
||||
<section label="4" id="gfdl-4">
|
||||
<title>Modifications</title>
|
||||
|
||||
<para>You may copy and distribute a Modified Version of the Document
|
||||
under the conditions of sections 2 and 3 above, provided that you release
|
||||
the Modified Version under precisely this License, with the Modified
|
||||
Version filling the role of the Document, thus licensing distribution and
|
||||
modification of the Modified Version to whoever possesses a copy of it.
|
||||
In addition, you must do these things in the Modified Version:</para>
|
||||
|
||||
<orderedlist numeration="upperalpha">
|
||||
<listitem>
|
||||
<para>Use in the Title Page (and on the covers, if any) a title
|
||||
distinct from that of the Document, and from those of previous
|
||||
versions (which should, if there were any, be listed in the History
|
||||
section of the Document). You may use the same title as a previous
|
||||
version if the original publisher of that version gives
|
||||
permission.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>List on the Title Page, as authors, one or more persons or
|
||||
entities responsible for authorship of the modifications in the
|
||||
Modified Version, together with at least five of the principal
|
||||
authors of the Document (all of its principal authors, if it has less
|
||||
than five).</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>State on the Title page the name of the publisher of the
|
||||
Modified Version, as the publisher.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Preserve all the copyright notices of the Document.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Add an appropriate copyright notice for your modifications
|
||||
adjacent to the other copyright notices.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Include, immediately after the copyright notices, a license
|
||||
notice giving the public permission to use the Modified Version under
|
||||
the terms of this License, in the form shown in the Addendum
|
||||
below.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Preserve in that license notice the full lists of Invariant
|
||||
Sections and required Cover Texts given in the Document's license
|
||||
notice.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Include an unaltered copy of this License.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Preserve the section entitled "History", and its title, and add
|
||||
to it an item stating at least the title, year, new authors, and
|
||||
publisher of the Modified Version as given on the Title Page. If
|
||||
there is no section entitled "History" in the Document, create one
|
||||
stating the title, year, authors, and publisher of the Document as
|
||||
given on its Title Page, then add an item describing the Modified
|
||||
Version as stated in the previous sentence.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Preserve the network location, if any, given in the Document
|
||||
for public access to a Transparent copy of the Document, and likewise
|
||||
the network locations given in the Document for previous versions it
|
||||
was based on. These may be placed in the "History" section. You may
|
||||
omit a network location for a work that was published at least four
|
||||
years before the Document itself, or if the original publisher of the
|
||||
version it refers to gives permission.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>In any section entitled "Acknowledgements" or "Dedications",
|
||||
preserve the section's title, and preserve in the section all the
|
||||
substance and tone of each of the contributor acknowledgements and/or
|
||||
dedications given therein.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Preserve all the Invariant Sections of the Document, unaltered
|
||||
in their text and in their titles. Section numbers or the equivalent
|
||||
are not considered part of the section titles.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Delete any section entitled "Endorsements". Such a section may
|
||||
not be included in the Modified Version.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Do not retitle any existing section as "Endorsements" or to
|
||||
conflict in title with any Invariant Section.</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
|
||||
<para>If the Modified Version includes new front-matter sections or
|
||||
appendices that qualify as Secondary Sections and contain no material
|
||||
copied from the Document, you may at your option designate some or all of
|
||||
these sections as invariant. To do this, add their titles to the list of
|
||||
Invariant Sections in the Modified Version's license notice. These titles
|
||||
must be distinct from any other section titles.</para>
|
||||
|
||||
<para>You may add a section entitled "Endorsements", provided it contains
|
||||
nothing but endorsements of your Modified Version by various parties--for
|
||||
example, statements of peer review or that the text has been approved by
|
||||
an organization as the authoritative definition of a standard.</para>
|
||||
|
||||
<para>You may add a passage of up to five words as a Front-Cover Text,
|
||||
and a passage of up to 25 words as a Back-Cover Text, to the end of the
|
||||
list of Cover Texts in the Modified Version. Only one passage of
|
||||
Front-Cover Text and one of Back-Cover Text may be added by (or through
|
||||
arrangements made by) any one entity. If the Document already includes a
|
||||
cover text for the same cover, previously added by you or by arrangement
|
||||
made by the same entity you are acting on behalf of, you may not add
|
||||
another; but you may replace the old one, on explicit permission from the
|
||||
previous publisher that added the old one.</para>
|
||||
|
||||
<para>The author(s) and publisher(s) of the Document do not by this
|
||||
License give permission to use their names for publicity for or to assert
|
||||
or imply endorsement of any Modified Version.</para>
|
||||
</section>
|
||||
|
||||
<section label="5" id="gfdl-5">
|
||||
<title>Combining Documents</title>
|
||||
|
||||
<para>You may combine the Document with other documents released under
|
||||
this License, under the terms defined in section 4 above for modified
|
||||
versions, provided that you include in the combination all of the
|
||||
Invariant Sections of all of the original documents, unmodified, and list
|
||||
them all as Invariant Sections of your combined work in its license
|
||||
notice.</para>
|
||||
|
||||
<para>The combined work need only contain one copy of this License, and
|
||||
multiple identical Invariant Sections may be replaced with a single copy.
|
||||
If there are multiple Invariant Sections with the same name but different
|
||||
contents, make the title of each such section unique by adding at the end
|
||||
of it, in parentheses, the name of the original author or publisher of
|
||||
that section if known, or else a unique number. Make the same adjustment
|
||||
to the section titles in the list of Invariant Sections in the license
|
||||
notice of the combined work.</para>
|
||||
|
||||
<para>In the combination, you must combine any sections entitled
|
||||
"History" in the various original documents, forming one section entitled
|
||||
"History"; likewise combine any sections entitled "Acknowledgements", and
|
||||
any sections entitled "Dedications". You must delete all sections
|
||||
entitled "Endorsements."</para>
|
||||
</section>
|
||||
|
||||
<section label="6" id="gfdl-6">
|
||||
<title>Collections of Documents</title>
|
||||
|
||||
<para>You may make a collection consisting of the Document and other
|
||||
documents released under this License, and replace the individual copies
|
||||
of this License in the various documents with a single copy that is
|
||||
included in the collection, provided that you follow the rules of this
|
||||
License for verbatim copying of each of the documents in all other
|
||||
respects.</para>
|
||||
|
||||
<para>You may extract a single document from such a collection, and
|
||||
distribute it individually under this License, provided you insert a copy
|
||||
of this License into the extracted document, and follow this License in
|
||||
all other respects regarding verbatim copying of that document.</para>
|
||||
</section>
|
||||
|
||||
<section label="7" id="gfdl-7">
|
||||
<title>Aggregation with Independent Works</title>
|
||||
|
||||
<para>A compilation of the Document or its derivatives with other
|
||||
separate and independent documents or works, in or on a volume of a
|
||||
storage or distribution medium, does not as a whole count as a Modified
|
||||
Version of the Document, provided no compilation copyright is claimed for
|
||||
the compilation. Such a compilation is called an "aggregate", and this
|
||||
License does not apply to the other self-contained works thus compiled
|
||||
with the Document, on account of their being thus compiled, if they are
|
||||
not themselves derivative works of the Document.</para>
|
||||
|
||||
<para>If the Cover Text requirement of section 3 is applicable to these
|
||||
copies of the Document, then if the Document is less than one quarter of
|
||||
the entire aggregate, the Document's Cover Texts may be placed on covers
|
||||
that surround only the Document within the aggregate. Otherwise they must
|
||||
appear on covers around the whole aggregate.</para>
|
||||
</section>
|
||||
|
||||
<section label="8" id="gfdl-8">
|
||||
<title>Translation</title>
|
||||
|
||||
<para>Translation is considered a kind of modification, so you may
|
||||
distribute translations of the Document under the terms of section 4.
|
||||
Replacing Invariant Sections with translations requires special
|
||||
permission from their copyright holders, but you may include translations
|
||||
of some or all Invariant Sections in addition to the original versions of
|
||||
these Invariant Sections. You may include a translation of this License
|
||||
provided that you also include the original English version of this
|
||||
License. In case of a disagreement between the translation and the
|
||||
original English version of this License, the original English version
|
||||
will prevail.</para>
|
||||
</section>
|
||||
|
||||
<section label="9" id="gfdl-9">
|
||||
<title>Termination</title>
|
||||
|
||||
<para>You may not copy, modify, sublicense, or distribute the Document
|
||||
except as expressly provided for under this License. Any other attempt to
|
||||
copy, modify, sublicense or distribute the Document is void, and will
|
||||
automatically terminate your rights under this License. However, parties
|
||||
who have received copies, or rights, from you under this License will not
|
||||
have their licenses terminated so long as such parties remain in full
|
||||
compliance.</para>
|
||||
</section>
|
||||
|
||||
<section label="10" id="gfdl-10">
|
||||
<title>Future Revisions of this License</title>
|
||||
|
||||
<para>The Free Software Foundation may publish new, revised versions of
|
||||
the GNU Free Documentation License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in
|
||||
detail to address new problems or concerns. See
|
||||
<ulink url="http://www.gnu.org/copyleft/"/>.</para>
|
||||
|
||||
<para>Each version of the License is given a distinguishing version
|
||||
number. If the Document specifies that a particular numbered version of
|
||||
this License "or any later version" applies to it, you have the option of
|
||||
following the terms and conditions either of that specified version or of
|
||||
any later version that has been published (not as a draft) by the Free
|
||||
Software Foundation. If the Document does not specify a version number of
|
||||
this License, you may choose any version ever published (not as a draft)
|
||||
by the Free Software Foundation.</para>
|
||||
</section>
|
||||
|
||||
<section label="" id="gfdl-howto">
|
||||
<title>How to use this License for your documents</title>
|
||||
|
||||
<para>To use this License in a document you have written, include a copy
|
||||
of the License in the document and put the following copyright and
|
||||
license notices just after the title page:</para>
|
||||
|
||||
<blockquote>
|
||||
<para>Copyright (c) YEAR YOUR NAME. Permission is granted to copy,
|
||||
distribute and/or modify this document under the terms of the GNU Free
|
||||
Documentation License, Version 1.1 or any later version published by
|
||||
the Free Software Foundation; with the Invariant Sections being LIST
|
||||
THEIR TITLES, with the Front-Cover Texts being LIST, and with the
|
||||
Back-Cover Texts being LIST. A copy of the license is included in the
|
||||
section entitled "GNU Free Documentation License".</para>
|
||||
</blockquote>
|
||||
|
||||
<para>If you have no Invariant Sections, write "with no Invariant
|
||||
Sections" instead of saying which ones are invariant. If you have no
|
||||
Front-Cover Texts, write "no Front-Cover Texts" instead of "Front-Cover
|
||||
Texts being LIST"; likewise for Back-Cover Texts.</para>
|
||||
|
||||
<para>If your document contains nontrivial examples of program code, we
|
||||
recommend releasing these examples in parallel under your choice of free
|
||||
software license, such as the GNU General Public License, to permit their
|
||||
use in free software.</para>
|
||||
</section>
|
||||
</appendix>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,555 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<glossary id="glossary">
|
||||
<glossdiv>
|
||||
<title>0-9, high ascii</title>
|
||||
|
||||
<glossentry id="gloss-htaccess">
|
||||
<glossterm>.htaccess</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Apache web server, and other NCSA-compliant web servers,
|
||||
observe the convention of using files in directories called
|
||||
<filename>.htaccess</filename>
|
||||
|
||||
to restrict access to certain files. In Bugzilla, they are used
|
||||
to keep secret files which would otherwise
|
||||
compromise your installation - e.g. the
|
||||
<filename>localconfig</filename>
|
||||
file contains the password to your database.
|
||||
curious.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-a">
|
||||
<title>A</title>
|
||||
|
||||
<glossentry id="gloss-apache">
|
||||
<glossterm>Apache</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>In this context, Apache is the web server most commonly used
|
||||
for serving up Bugzilla
|
||||
pages. Contrary to popular belief, the apache web server has nothing
|
||||
to do with the ancient and noble Native American tribe, but instead
|
||||
derived its name from the fact that it was
|
||||
<quote>a patchy</quote>
|
||||
version of the original
|
||||
<acronym>NCSA</acronym>
|
||||
world-wide-web server.</para>
|
||||
|
||||
<variablelist>
|
||||
<title>Useful Directives when configuring Bugzilla</title>
|
||||
|
||||
<varlistentry>
|
||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#addhandler">AddHandler</ulink></computeroutput></term>
|
||||
<listitem>
|
||||
<para>Tell Apache that it's OK to run CGI scripts.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#allowoverride">AllowOverride</ulink></computeroutput></term>
|
||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#options">Options</ulink></computeroutput></term>
|
||||
<listitem>
|
||||
<para>These directives are used to tell Apache many things about
|
||||
the directory they apply to. For Bugzilla's purposes, we need
|
||||
them to allow script execution and <filename>.htaccess</filename>
|
||||
overrides.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/mod_dir.html#directoryindex">DirectoryIndex</ulink></computeroutput></term>
|
||||
<listitem>
|
||||
<para>Used to tell Apache what files are indexes. If you can
|
||||
not add <filename>index.cgi</filename> to the list of valid files,
|
||||
you'll need to set <computeroutput>$index_html</computeroutput> to
|
||||
1 in <filename>localconfig</filename> so
|
||||
<command>./checksetup.pl</command> will create an
|
||||
<filename>index.html</filename> that redirects to
|
||||
<filename>index.cgi</filename>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource">ScriptInterpreterSource</ulink></computeroutput></term>
|
||||
<listitem>
|
||||
<para>Used when running Apache on windows so the shebang line
|
||||
doesn't have to be changed in every Bugzilla script.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>For more information about how to configure Apache for Bugzilla,
|
||||
see <xref linkend="http-apache"/>.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-b">
|
||||
<title>B</title>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>Bug</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>A
|
||||
<quote>bug</quote>
|
||||
|
||||
in Bugzilla refers to an issue entered into the database which has an
|
||||
associated number, assignments, comments, etc. Some also refer to a
|
||||
<quote>tickets</quote>
|
||||
or
|
||||
<quote>issues</quote>;
|
||||
in the context of Bugzilla, they are synonymous.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>Bug Number</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Each Bugzilla bug is assigned a number that uniquely identifies
|
||||
that bug. The bug associated with a bug number can be pulled up via a
|
||||
query, or easily from the very front page by typing the number in the
|
||||
"Find" box.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-bugzilla">
|
||||
<glossterm>Bugzilla</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Bugzilla is the world-leading free software bug tracking system.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-c">
|
||||
<title>C</title>
|
||||
|
||||
<glossentry id="gloss-cgi">
|
||||
<glossterm>Common Gateway Interface</glossterm>
|
||||
<acronym>CGI</acronym>
|
||||
<glossdef>
|
||||
<para><acronym>CGI</acronym> is an acronym for Common Gateway Interface. This is
|
||||
a standard for interfacing an external application with a web server. Bugzilla
|
||||
is an example of a <acronym>CGI</acronym> application.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-component">
|
||||
<glossterm>Component</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>A Component is a subsection of a Product. It should be a narrow
|
||||
category, tailored to your organization. All Products must contain at
|
||||
least one Component (and, as a matter of fact, creating a Product
|
||||
with no Components will create an error in Bugzilla).</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-cpan">
|
||||
<glossterm>Comprehensive Perl Archive Network</glossterm>
|
||||
<acronym>CPAN</acronym>
|
||||
|
||||
<!-- TODO: Rewrite def for CPAN -->
|
||||
<glossdef>
|
||||
<para>
|
||||
<acronym>CPAN</acronym>
|
||||
|
||||
stands for the
|
||||
<quote>Comprehensive Perl Archive Network</quote>.
|
||||
CPAN maintains a large number of extremely useful
|
||||
<glossterm>Perl</glossterm>
|
||||
modules - encapsulated chunks of code for performing a
|
||||
particular task.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-contrib">
|
||||
<glossterm><filename class="directory">contrib</filename></glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>The <filename class="directory">contrib</filename> directory is
|
||||
a location to put scripts that have been contributed to Bugzilla but
|
||||
are not a part of the official distribution. These scripts are written
|
||||
by third parties and may be in languages other than perl. For those
|
||||
that are in perl, there may be additional modules or other requirements
|
||||
than those of the official distribution.
|
||||
<note>
|
||||
<para>Scripts in the <filename class="directory">contrib</filename>
|
||||
directory are not officially supported by the Bugzilla team and may
|
||||
break in between versions.
|
||||
</para>
|
||||
</note>
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-d">
|
||||
<title>D</title>
|
||||
|
||||
<glossentry id="gloss-daemon">
|
||||
<glossterm>daemon</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>A daemon is a computer program which runs in the background. In
|
||||
general, most daemons are started at boot time via System V init
|
||||
scripts, or through RC scripts on BSD-based systems.
|
||||
<glossterm>mysqld</glossterm>,
|
||||
the MySQL server, and
|
||||
<glossterm>apache</glossterm>,
|
||||
a web server, are generally run as daemons.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-dos">
|
||||
<glossterm>DOS Attack</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>A DOS, or Denial of Service attack, is when a user attempts to
|
||||
deny access to a web server by repeatedly accessing a page or sending
|
||||
malformed requests to a webserver. A D-DOS, or
|
||||
Distributed Denial of Service attack, is when these requests come
|
||||
from multiple sources at the same time. Unfortunately, these are much
|
||||
more difficult to defend against.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-g">
|
||||
<title>G</title>
|
||||
|
||||
<glossentry id="gloss-groups">
|
||||
<glossterm>Groups</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>The word
|
||||
<quote>Groups</quote>
|
||||
|
||||
has a very special meaning to Bugzilla. Bugzilla's main security
|
||||
mechanism comes by placing users in groups, and assigning those
|
||||
groups certain privileges to view bugs in particular
|
||||
<glossterm>Products</glossterm>
|
||||
in the
|
||||
<glossterm>Bugzilla</glossterm>
|
||||
database.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-j">
|
||||
<title>J</title>
|
||||
|
||||
<glossentry id="gloss-javascript">
|
||||
<glossterm>JavaScript</glossterm>
|
||||
<glossdef>
|
||||
<para>JavaScript is cool, we should talk about it.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-m">
|
||||
<title>M</title>
|
||||
|
||||
<glossentry id="gloss-mta">
|
||||
<glossterm>Message Transport Agent</glossterm>
|
||||
<acronym>MTA</acronym>
|
||||
|
||||
<glossdef>
|
||||
<para>A Message Transport Agent is used to control the flow of email on a system.
|
||||
The <ulink url="http://search.cpan.org/dist/Email-Send/lib/Email/Send.pm">Email::Send</ulink>
|
||||
Perl module, which Bugzilla uses to send email, can be configured to
|
||||
use many different underlying implementations for actually sending the
|
||||
mail using the <option>mail_delivery_method</option> parameter.
|
||||
Implementations other than <literal>sendmail</literal> require that the
|
||||
<option>sendmailnow</option> param be set to <literal>on</literal>.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-mysql">
|
||||
<glossterm>MySQL</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>MySQL is currently the required
|
||||
<glossterm linkend="gloss-rdbms">RDBMS</glossterm> for Bugzilla. MySQL
|
||||
can be downloaded from <ulink url="http://www.mysql.com"/>. While you
|
||||
should familiarize yourself with all of the documentation, some high
|
||||
points are:
|
||||
</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><ulink url="http://www.mysql.com/doc/en/Backup.html">Backup</ulink></term>
|
||||
<listitem>
|
||||
<para>Methods for backing up your Bugzilla database.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><ulink url="http://www.mysql.com/doc/en/Option_files.html">Option Files</ulink></term>
|
||||
<listitem>
|
||||
<para>Information about how to configure MySQL using
|
||||
<filename>my.cnf</filename>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><ulink url="http://www.mysql.com/doc/en/Privilege_system.html">Privilege System</ulink></term>
|
||||
<listitem>
|
||||
<para>Much more detailed information about the suggestions in
|
||||
<xref linkend="security-mysql"/>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-p">
|
||||
<title>P</title>
|
||||
|
||||
<glossentry id="gloss-ppm">
|
||||
<glossterm>Perl Package Manager</glossterm>
|
||||
<acronym>PPM</acronym>
|
||||
|
||||
<glossdef>
|
||||
<para><ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/PPM/"/>
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm id="gloss-product">Product</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>A Product is a broad category of types of bugs, normally
|
||||
representing a single piece of software or entity. In general,
|
||||
there are several Components to a Product. A Product may define a
|
||||
group (used for security) for all bugs entered into
|
||||
its Components.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>Perl</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>First written by Larry Wall, Perl is a remarkable program
|
||||
language. It has the benefits of the flexibility of an interpreted
|
||||
scripting language (such as shell script), combined with the speed
|
||||
and power of a compiled language, such as C.
|
||||
<glossterm>Bugzilla</glossterm>
|
||||
|
||||
is maintained in Perl.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-q">
|
||||
<title>Q</title>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>QA</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>
|
||||
<quote>QA</quote>,
|
||||
<quote>Q/A</quote>, and
|
||||
<quote>Q.A.</quote>
|
||||
are short for
|
||||
<quote>Quality Assurance</quote>.
|
||||
In most large software development organizations, there is a team
|
||||
devoted to ensuring the product meets minimum standards before
|
||||
shipping. This team will also generally want to track the progress of
|
||||
bugs over their life cycle, thus the need for the
|
||||
<quote>QA Contact</quote>
|
||||
|
||||
field in a bug.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-r">
|
||||
<title>R</title>
|
||||
|
||||
<glossentry id="gloss-rdbms">
|
||||
<glossterm>Relational DataBase Management System</glossterm>
|
||||
<acronym>RDBMS</acronym>
|
||||
|
||||
<glossdef>
|
||||
<para>A relational database management system is a database system
|
||||
that stores information in tables that are related to each other.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-regexp">
|
||||
<glossterm>Regular Expression</glossterm>
|
||||
<acronym>regexp</acronym>
|
||||
|
||||
<glossdef>
|
||||
<para>A regular expression is an expression used for pattern matching.
|
||||
<ulink url="http://perldoc.com/perl5.6/pod/perlre.html#Regular-Expressions">Documentation</ulink>
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-s">
|
||||
<title>S</title>
|
||||
|
||||
<glossentry id="gloss-service">
|
||||
<glossterm>Service</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>In Windows NT environment, a boot-time background application
|
||||
is referred to as a service. These are generally managed through the
|
||||
control panel while logged in as an account with
|
||||
<quote>Administrator</quote> level capabilities. For more
|
||||
information, consult your Windows manual or the MSKB.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>
|
||||
<acronym>SGML</acronym>
|
||||
</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>
|
||||
<acronym>SGML</acronym>
|
||||
|
||||
stands for
|
||||
<quote>Standard Generalized Markup Language</quote>.
|
||||
Created in the 1980's to provide an extensible means to maintain
|
||||
documentation based upon content instead of presentation,
|
||||
<acronym>SGML</acronym>
|
||||
|
||||
has withstood the test of time as a robust, powerful language.
|
||||
<glossterm>
|
||||
<acronym>XML</acronym>
|
||||
</glossterm>
|
||||
|
||||
is the
|
||||
<quote>baby brother</quote>
|
||||
|
||||
of SGML; any valid
|
||||
<acronym>XML</acronym>
|
||||
|
||||
document it, by definition, a valid
|
||||
<acronym>SGML</acronym>
|
||||
|
||||
document. The document you are reading is written and maintained in
|
||||
<acronym>SGML</acronym>,
|
||||
and is also valid
|
||||
<acronym>XML</acronym>
|
||||
|
||||
if you modify the Document Type Definition.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-t">
|
||||
<title>T</title>
|
||||
|
||||
<glossentry id="gloss-target-milestone" xreflabel="Target Milestone">
|
||||
<glossterm>Target Milestone</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Target Milestones are Product goals. They are configurable on a
|
||||
per-Product basis. Most software development houses have a concept of
|
||||
|
||||
<quote>milestones</quote>
|
||||
|
||||
where the people funding a project expect certain functionality on
|
||||
certain dates. Bugzilla facilitates meeting these milestones by
|
||||
giving you the ability to declare by which milestone a bug will be
|
||||
fixed, or an enhancement will be implemented.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="gloss-tcl">
|
||||
<glossterm>Tool Command Language</glossterm>
|
||||
<acronym>TCL</acronym>
|
||||
<glossdef>
|
||||
<para>TCL is an open source scripting language available for Windows,
|
||||
Macintosh, and Unix based systems. Bugzilla 1.0 was written in TCL but
|
||||
never released. The first release of Bugzilla was 2.0, which was when
|
||||
it was ported to perl.
|
||||
</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv id="gloss-z">
|
||||
<title>Z</title>
|
||||
|
||||
<glossentry id="gloss-zarro">
|
||||
<glossterm>Zarro Boogs Found</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>This is just a goofy way of saying that there were no bugs
|
||||
found matching your query. When asked to explain this message,
|
||||
Terry had the following to say:
|
||||
</para>
|
||||
|
||||
<blockquote>
|
||||
<attribution>Terry Weissman</attribution>
|
||||
<para>I've been asked to explain this ... way back when, when
|
||||
Netscape released version 4.0 of its browser, we had a release
|
||||
party. Naturally, there had been a big push to try and fix every
|
||||
known bug before the release. Naturally, that hadn't actually
|
||||
happened. (This is not unique to Netscape or to 4.0; the same thing
|
||||
has happened with every software project I've ever seen.) Anyway,
|
||||
at the release party, T-shirts were handed out that said something
|
||||
like "Netscape 4.0: Zarro Boogs". Just like the software, the
|
||||
T-shirt had no known bugs. Uh-huh.
|
||||
</para>
|
||||
|
||||
<para>So, when you query for a list of bugs, and it gets no results,
|
||||
you can think of this as a friendly reminder. Of *course* there are
|
||||
bugs matching your query, they just aren't in the bugsystem yet...
|
||||
</para>
|
||||
</blockquote>
|
||||
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
</glossary>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
@@ -1,21 +0,0 @@
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,124 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<!-- Keep these tools listings in alphabetical order please. -MPB -->
|
||||
<section id="integration">
|
||||
<title>Integrating Bugzilla with Third-Party Tools</title>
|
||||
|
||||
<section id="bonsai"
|
||||
xreflabel="Bonsai, the Mozilla automated CVS management system">
|
||||
<title>Bonsai</title>
|
||||
|
||||
<para>Bonsai is a web-based tool for managing
|
||||
<xref linkend="cvs" />
|
||||
|
||||
. Using Bonsai, administrators can control open/closed status of trees,
|
||||
query a fast relational database back-end for change, branch, and comment
|
||||
information, and view changes made since the last time the tree was
|
||||
closed. Bonsai
|
||||
also integrates with
|
||||
<xref linkend="tinderbox" />.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="cvs" xreflabel="CVS, the Concurrent Versioning System">
|
||||
<title>CVS</title>
|
||||
|
||||
<para>CVS integration is best accomplished, at this point, using the
|
||||
Bugzilla Email Gateway.</para>
|
||||
|
||||
<para>Follow the instructions in this Guide for enabling Bugzilla e-mail
|
||||
integration. Ensure that your check-in script sends an email to your
|
||||
Bugzilla e-mail gateway with the subject of
|
||||
<quote>[Bug XXXX]</quote>,
|
||||
and you can have CVS check-in comments append to your Bugzilla bug. If
|
||||
you want to have the bug be closed automatically, you'll have to modify
|
||||
the <filename>contrib/bugzilla_email_append.pl</filename> script.
|
||||
</para>
|
||||
|
||||
<para>There is also a CVSZilla project, based upon somewhat dated
|
||||
Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to
|
||||
email. Check it out at: <ulink url="http://www.cvszilla.org/"/>.
|
||||
</para>
|
||||
|
||||
<para>Another system capable of CVS integration with Bugzilla is
|
||||
Scmbug. This system provides generic integration of Source code
|
||||
Configuration Management with Bugtracking. Check it out at: <ulink
|
||||
url="http://freshmeat.net/projects/scmbug/"/>.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="scm"
|
||||
xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS">
|
||||
|
||||
<title>Perforce SCM</title>
|
||||
|
||||
<para>You can find the project page for Bugzilla and Teamtrack Perforce
|
||||
integration (p4dti) at:
|
||||
<ulink url="http://www.ravenbrook.com/project/p4dti/"/>
|
||||
|
||||
.
|
||||
<quote>p4dti</quote>
|
||||
|
||||
is now an officially supported product from Perforce, and you can find
|
||||
the "Perforce Public Depot" p4dti page at
|
||||
<ulink url="http://public.perforce.com/public/perforce/p4dti/index.html"/>
|
||||
|
||||
.</para>
|
||||
|
||||
<para>Integration of Perforce with Bugzilla, once patches are applied, is
|
||||
seamless. Perforce replication information will appear below the comments
|
||||
of each bug. Be certain you have a matching set of patches for the
|
||||
Bugzilla version you are installing. p4dti is designed to support
|
||||
multiple defect trackers, and maintains its own documentation for it.
|
||||
Please consult the pages linked above for further information.</para>
|
||||
</section>
|
||||
|
||||
<section id="svn"
|
||||
xreflabel="Subversion, a compelling replacement for CVS">
|
||||
<title>Subversion</title>
|
||||
<para>Subversion is a free/open-source version control system,
|
||||
designed to overcome various limitations of CVS. Integration of
|
||||
Subversion with Bugzilla is possible using Scmbug, a system
|
||||
providing generic integration of Source Code Configuration
|
||||
Management with Bugtracking. Scmbug is available at <ulink
|
||||
url="http://freshmeat.net/projects/scmbug/"/>.</para>
|
||||
</section>
|
||||
|
||||
<section id="tinderbox"
|
||||
xreflabel="Tinderbox, the Mozilla automated build management system">
|
||||
<title>Tinderbox/Tinderbox2</title>
|
||||
|
||||
<para>Tinderbox is a continuous-build system which can integrate with
|
||||
Bugzilla - see
|
||||
<ulink url="http://www.mozilla.org/projects/tinderbox"/> for details
|
||||
of Tinderbox, and
|
||||
<ulink url="http://tinderbox.mozilla.org/showbuilds.cgi"/> to see it
|
||||
in action.</para>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,121 +0,0 @@
|
||||
<chapter id="introduction">
|
||||
<title>Introduction</title>
|
||||
|
||||
<section id="what-is-bugzilla">
|
||||
<title>What is Bugzilla?</title>
|
||||
|
||||
<para>
|
||||
Bugzilla is a bug- or issue-tracking system. Bug-tracking
|
||||
systems allow individual or groups of developers effectively to keep track
|
||||
of outstanding problems with their products.
|
||||
</para>
|
||||
|
||||
<para><emphasis>Do we need more here?</emphasis></para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="why-tracking">
|
||||
<title>Why use a bug-tracking system?</title>
|
||||
|
||||
<para>Those who do not use a bug-tracking system tend to rely on
|
||||
shared lists, email, spreadsheets and/or Post-It notes to monitor the
|
||||
status of defects. This procedure
|
||||
is usually error-prone and tends to cause those bugs judged least
|
||||
significant by developers to be dropped or ignored.</para>
|
||||
|
||||
<para>Integrated defect-tracking systems make sure that nothing gets
|
||||
swept under the carpet; they provide a method of creating, storing,
|
||||
arranging and processing defect reports and enhancement requests.</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="why-bugzilla">
|
||||
<title>Why use Bugzilla?</title>
|
||||
|
||||
<para>Bugzilla is the leading open-source/free software bug tracking
|
||||
system. It boasts many advanced features, including:
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Powerful searching</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>User-configurable email notifications of bug changes</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Full change history</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Inter-bug dependency tracking and graphing</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Excellent attachment management</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Integrated, product-based, granular security schema</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Fully security-audited, and runs under Perl's taint mode</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>A robust, stable RDBMS back-end</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Completely customizable and/or localizable web user
|
||||
interface</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Additional XML, email and console interfaces</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Extensive configurability</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Smooth upgrade pathway between versions</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
|
||||
<para>Bugzilla is very adaptable to various situations. Known uses
|
||||
currently include IT support queues, Systems Administration deployment
|
||||
management, chip design and development problem tracking (both
|
||||
pre-and-post fabrication), and software and hardware bug tracking for
|
||||
luminaries such as Redhat, NASA, Linux-Mandrake, and VA Systems.
|
||||
Combined with systems such as
|
||||
<ulink url="http://www.cvshome.org">CVS</ulink>,
|
||||
<ulink url="http://www.mozilla.org/bonsai.html">Bonsai</ulink>, or
|
||||
<ulink url="http://www.perforce.com">Perforce SCM</ulink>, Bugzilla
|
||||
provides a powerful, easy-to-use configuration management solution.</para>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
@@ -1,197 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<appendix id="install-perlmodules-manual">
|
||||
<title>Manual Installation of Perl Modules</title>
|
||||
|
||||
<section id="modules-manual-instructions">
|
||||
<title>Instructions</title>
|
||||
<para>
|
||||
If you need to install Perl modules manually, here's how it's done.
|
||||
Download the module using the link given in the next section, and then
|
||||
apply this magic incantation, as root:
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<screen><prompt>bash#</prompt> tar -xzvf <module>.tar.gz
|
||||
<prompt>bash#</prompt> cd <module>
|
||||
<prompt>bash#</prompt> perl Makefile.PL
|
||||
<prompt>bash#</prompt> make
|
||||
<prompt>bash#</prompt> make test
|
||||
<prompt>bash#</prompt> make install</screen>
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
In order to compile source code under Windows you will need to obtain
|
||||
a 'make' utility. The <command>nmake</command> utility provided with
|
||||
Microsoft Visual C++ may be used. As an alternative, there is a
|
||||
utility called <command>dmake</command> available from CPAN which is
|
||||
written entirely in Perl.
|
||||
</para>
|
||||
<para>
|
||||
As described in <xref linkend="modules-manual-download" />, however, most
|
||||
packages already exist and are available from ActiveState or theory58S.
|
||||
We highly recommend that you install them using the ppm GUI available with
|
||||
ActiveState and to add the theory58S repository to your list of repositories.
|
||||
</para>
|
||||
</note>
|
||||
</section>
|
||||
|
||||
<section id="modules-manual-download">
|
||||
<title>Download Locations</title>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
Running Bugzilla on Windows requires the use of ActiveState
|
||||
Perl 5.8.1 or higher. Many modules already exist in the core
|
||||
distribution of ActiveState Perl. Additional modules can be downloaded
|
||||
from <ulink url="http://theoryx5.uwinnipeg.ca/ppms/" /> if you use
|
||||
Perl 5.8.x or from <ulink url="http://cpan.uwinnipeg.ca/PPMPackages/10xx/" />
|
||||
if you use Perl 5.10.x.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
CGI:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/CGI.pm/"/>
|
||||
Documentation: <ulink url="http://perldoc.perl.org/CGI.html"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Data-Dumper:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Data-Dumper/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/Data-Dumper/Dumper.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Date::Format (part of TimeDate):
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/TimeDate/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
DBI:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/DBI/"/>
|
||||
Documentation: <ulink url="http://dbi.perl.org/docs/"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
DBD::mysql:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/DBD-mysql/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
DBD::Pg:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/DBD-Pg/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/DBD-Pg/Pg.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
File::Spec:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/File-Spec/"/>
|
||||
Documentation: <ulink url="http://perldoc.perl.org/File/Spec.html"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Template-Toolkit:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Template-Toolkit/"/>
|
||||
Documentation: <ulink url="http://www.template-toolkit.org/docs.html"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
GD:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/GD/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/GD/GD.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Template::Plugin::GD:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Template-GD/" />
|
||||
Documentation: <ulink url="http://www.template-toolkit.org/docs/aqua/Modules/index.html" />
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
MIME::Parser (part of MIME-tools):
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/MIME-tools/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="modules-manual-optional">
|
||||
<title>Optional Modules</title>
|
||||
|
||||
<para>
|
||||
Chart::Base:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Chart/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/Chart/Chart.pod"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
GD::Graph:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/GDGraph/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/GDGraph/Graph.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
GD::Text::Align (part of GD::Text::Util):
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/GDTextUtil/"/>
|
||||
Documentation: <ulink url="http://search.cpan.org/dist/GDTextUtil/Text/Align.pm"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
XML::Twig:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/XML-Twig/"/>
|
||||
Documentation: <ulink url="http://standards.ieee.org/resources/spasystem/twig/twig_stable.html"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
PatchReader:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/author/JKEISER/PatchReader/"/>
|
||||
Documentation: <ulink url="http://www.johnkeiser.com/mozilla/Patch_Viewer.html"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Image::Magick:
|
||||
<literallayout>
|
||||
CPAN Download Page: <ulink url="http://search.cpan.org/dist/PerlMagick/"/>
|
||||
Documentation: <ulink url="http://www.imagemagick.org/script/resources.php"/>
|
||||
</literallayout>
|
||||
</para>
|
||||
</section>
|
||||
</appendix>
|
||||
@@ -1,135 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
|
||||
<title>Contrib</title>
|
||||
|
||||
<para>
|
||||
There are a number of unofficial Bugzilla add-ons in the
|
||||
<filename class="directory">$BUGZILLA_ROOT/contrib/</filename>
|
||||
directory. This section documents them.
|
||||
</para>
|
||||
|
||||
<section id="cmdline">
|
||||
<title>Command-line Search Interface</title>
|
||||
|
||||
<para>
|
||||
There are a suite of Unix utilities for searching Bugzilla from the
|
||||
command line. They live in the
|
||||
<filename class="directory">contrib/cmdline</filename> directory.
|
||||
There are three files - <filename>query.conf</filename>,
|
||||
<filename>buglist</filename> and <filename>bugs</filename>.
|
||||
</para>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
These files pre-date the templatization work done as part of the
|
||||
2.16 release, and have not been updated.
|
||||
</para>
|
||||
</warning>
|
||||
|
||||
<para>
|
||||
<filename>query.conf</filename> contains the mapping from
|
||||
options to field names and comparison types. Quoted option names
|
||||
are <quote>grepped</quote> for, so it should be easy to edit this
|
||||
file. Comments (#) have no effect; you must make sure these lines
|
||||
do not contain any quoted <quote>option</quote>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<filename>buglist</filename> is a shell script that submits a
|
||||
Bugzilla query and writes the resulting HTML page to stdout.
|
||||
It supports both short options, (such as <quote>-Afoo</quote>
|
||||
or <quote>-Rbar</quote>) and long options (such
|
||||
as <quote>--assignedto=foo</quote> or <quote>--reporter=bar</quote>).
|
||||
If the first character of an option is not <quote>-</quote>, it is
|
||||
treated as if it were prefixed with <quote>--default=</quote>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The column list is taken from the COLUMNLIST environment variable.
|
||||
This is equivalent to the <quote>Change Columns</quote> option
|
||||
that is available when you list bugs in buglist.cgi. If you have
|
||||
already used Bugzilla, grep for COLUMNLIST in your cookies file
|
||||
to see your current COLUMNLIST setting.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<filename>bugs</filename> is a simple shell script which calls
|
||||
<filename>buglist</filename> and extracts the
|
||||
bug numbers from the output. Adding the prefix
|
||||
<quote>http://bugzilla.mozilla.org/buglist.cgi?bug_id=</quote>
|
||||
turns the bug list into a working link if any bugs are found.
|
||||
Counting bugs is easy. Pipe the results through
|
||||
<command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Akkana Peck says she has good results piping
|
||||
<filename>buglist</filename> output through
|
||||
<command>w3m -T text/html -dump</command>
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="cmdline-bugmail">
|
||||
<title>Command-line 'Send Unsent Bug-mail' tool</title>
|
||||
|
||||
<para>
|
||||
Within the <filename class="directory">contrib</filename> directory
|
||||
exists a utility with the descriptive (if compact) name
|
||||
of <filename>sendunsentbugmail.pl</filename>. The purpose of this
|
||||
script is, simply, to send out any bug-related mail that should
|
||||
have been sent by now, but for one reason or another has not.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To accomplish this task, <filename>sendunsentbugmail.pl</filename> uses
|
||||
the same mechanism as the <filename>sanitycheck.cgi</filename> script;
|
||||
it scans through the entire database looking for bugs with changes that
|
||||
were made more than 30 minutes ago, but where there is no record of
|
||||
anyone related to that bug having been sent mail. Having compiled a list,
|
||||
it then uses the standard rules to determine who gets mail, and sends it
|
||||
out.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
As the script runs, it indicates the bug for which it is currently
|
||||
sending mail; when it has finished, it gives a numerical count of how
|
||||
many mails were sent and how many people were excluded. (Individual
|
||||
user names are not recorded or displayed.) If the script produces
|
||||
no output, that means no unsent mail was detected.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<emphasis>Usage</emphasis>: move the sendunsentbugmail.pl script
|
||||
up into the main directory, ensure it has execute permission, and run it
|
||||
from the command line (or from a cron job) with no parameters.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
</appendix>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,77 +0,0 @@
|
||||
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
|
||||
<appendix id="downloadlinks">
|
||||
<title>Software Download Links</title>
|
||||
|
||||
<para>All of these sites are current as of April, 2001. Hopefully they'll
|
||||
stay current for a while.</para>
|
||||
|
||||
<para>Apache Web Server:
|
||||
<ulink url="http://www.apache.org/"/>
|
||||
|
||||
Optional web server for Bugzilla, but recommended because of broad user
|
||||
base and support.</para>
|
||||
|
||||
<para>Bugzilla:
|
||||
<ulink url="http://www.bugzilla.org/"/>
|
||||
</para>
|
||||
|
||||
<para>MySQL:
|
||||
<ulink url="http://www.mysql.com/"/>
|
||||
</para>
|
||||
|
||||
<para>Perl:
|
||||
<ulink url="http://www.perl.org/"/>
|
||||
</para>
|
||||
|
||||
<para>CPAN:
|
||||
<ulink url="http://www.cpan.org/"/>
|
||||
</para>
|
||||
|
||||
<para>DBI Perl module:
|
||||
<ulink url="http://www.cpan.org/modules/by-module/DBI/"/>
|
||||
</para>
|
||||
|
||||
<para>MySQL related Perl modules:
|
||||
<ulink url="http://www.cpan.org/modules/by-module/Mysql/"/>
|
||||
</para>
|
||||
|
||||
<para>TimeDate Perl module collection:
|
||||
<ulink url="http://www.cpan.org/modules/by-module/Date/"/>
|
||||
</para>
|
||||
|
||||
<para>GD Perl module:
|
||||
<ulink url="http://www.cpan.org/modules/by-module/GD/"/>
|
||||
|
||||
Alternately, you should be able to find the latest version of GD at
|
||||
<ulink url="http://www.boutell.com/gd/"/>
|
||||
</para>
|
||||
|
||||
<para>Chart::Base module:
|
||||
<ulink url="http://www.cpan.org/modules/by-module/Chart/"/>
|
||||
</para>
|
||||
|
||||
<para>(But remember, Bundle::Bugzilla will install all the modules for you.)
|
||||
</para>
|
||||
</appendix>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End:
|
||||
-->
|
||||
|
||||
@@ -1,364 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<!-- $Id: security.xml,v 1.19.2.1 2008-07-13 16:44:28 mozilla%colinogilvie.co.uk Exp $ -->
|
||||
|
||||
<chapter id="security">
|
||||
<title>Bugzilla Security</title>
|
||||
|
||||
<para>While some of the items in this chapter are related to the operating
|
||||
system Bugzilla is running on or some of the support software required to
|
||||
run Bugzilla, it is all related to protecting your data. This is not
|
||||
intended to be a comprehensive guide to securing Linux, Apache, MySQL, or
|
||||
any other piece of software mentioned. There is no substitute for active
|
||||
administration and monitoring of a machine. The key to good security is
|
||||
actually right in the middle of the word: <emphasis>U R It</emphasis>.
|
||||
</para>
|
||||
|
||||
<para>While programmers in general always strive to write secure code,
|
||||
accidents can and do happen. The best approach to security is to always
|
||||
assume that the program you are working with isn't 100% secure and restrict
|
||||
its access to other parts of your machine as much as possible.
|
||||
</para>
|
||||
|
||||
<section id="security-os">
|
||||
<title>Operating System</title>
|
||||
|
||||
<section id="security-os-ports">
|
||||
<title>TCP/IP Ports</title>
|
||||
|
||||
<!-- TODO: Get exact number of ports -->
|
||||
<para>The TCP/IP standard defines more than 65,000 ports for sending
|
||||
and receiving traffic. Of those, Bugzilla needs exactly one to operate
|
||||
(different configurations and options may require up to 3). You should
|
||||
audit your server and make sure that you aren't listening on any ports
|
||||
you don't need to be. It's also highly recommended that the server
|
||||
Bugzilla resides on, along with any other machines you administer, be
|
||||
placed behind some kind of firewall.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="security-os-accounts">
|
||||
<title>System User Accounts</title>
|
||||
|
||||
<para>Many <glossterm linkend="gloss-daemon">daemons</glossterm>, such
|
||||
as Apache's <filename>httpd</filename> or MySQL's
|
||||
<filename>mysqld</filename>, run as either <quote>root</quote> or
|
||||
<quote>nobody</quote>. This is even worse on Windows machines where the
|
||||
majority of <glossterm linkend="gloss-service">services</glossterm>
|
||||
run as <quote>SYSTEM</quote>. While running as <quote>root</quote> or
|
||||
<quote>SYSTEM</quote> introduces obvious security concerns, the
|
||||
problems introduced by running everything as <quote>nobody</quote> may
|
||||
not be so obvious. Basically, if you run every daemon as
|
||||
<quote>nobody</quote> and one of them gets compromised it can
|
||||
compromise every other daemon running as <quote>nobody</quote> on your
|
||||
machine. For this reason, it is recommended that you create a user
|
||||
account for each daemon.
|
||||
</para>
|
||||
|
||||
<note>
|
||||
<para>You will need to set the <option>webservergroup</option> option
|
||||
in <filename>localconfig</filename> to the group your web server runs
|
||||
as. This will allow <filename>./checksetup.pl</filename> to set file
|
||||
permissions on Unix systems so that nothing is world-writable.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="security-os-chroot">
|
||||
<title>The <filename>chroot</filename> Jail</title>
|
||||
|
||||
<para>
|
||||
If your system supports it, you may wish to consider running
|
||||
Bugzilla inside of a <filename>chroot</filename> jail. This option
|
||||
provides unprecedented security by restricting anything running
|
||||
inside the jail from accessing any information outside of it. If you
|
||||
wish to use this option, please consult the documentation that came
|
||||
with your system.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<section id="security-mysql">
|
||||
<title>MySQL</title>
|
||||
|
||||
<section id="security-mysql-account">
|
||||
<title>The MySQL System Account</title>
|
||||
|
||||
<para>As mentioned in <xref linkend="security-os-accounts"/>, the MySQL
|
||||
daemon should run as a non-privileged, unique user. Be sure to consult
|
||||
the MySQL documentation or the documentation that came with your system
|
||||
for instructions.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="security-mysql-root">
|
||||
<title>The MySQL <quote>root</quote> and <quote>anonymous</quote> Users</title>
|
||||
|
||||
<para>By default, MySQL comes with a <quote>root</quote> user with a
|
||||
blank password and an <quote>anonymous</quote> user, also with a blank
|
||||
password. In order to protect your data, the <quote>root</quote> user
|
||||
should be given a password and the anonymous user should be disabled.
|
||||
</para>
|
||||
|
||||
<example id="security-mysql-account-root">
|
||||
<title>Assigning the MySQL <quote>root</quote> User a Password</title>
|
||||
|
||||
<screen>
|
||||
<prompt>bash$</prompt> mysql mysql
|
||||
<prompt>mysql></prompt> UPDATE user SET password = password('<replaceable>new_password</replaceable>') WHERE user = 'root';
|
||||
<prompt>mysql></prompt> FLUSH PRIVILEGES;
|
||||
</screen>
|
||||
</example>
|
||||
|
||||
<example id="security-mysql-account-anonymous">
|
||||
<title>Disabling the MySQL <quote>anonymous</quote> User</title>
|
||||
<screen>
|
||||
<prompt>bash$</prompt> mysql -u root -p mysql <co id="security-mysql-account-anonymous-mysql"/>
|
||||
<prompt>Enter Password:</prompt> <replaceable>new_password</replaceable>
|
||||
<prompt>mysql></prompt> DELETE FROM user WHERE user = '';
|
||||
<prompt>mysql></prompt> FLUSH PRIVILEGES;
|
||||
</screen>
|
||||
<calloutlist>
|
||||
<callout arearefs="security-mysql-account-anonymous-mysql">
|
||||
<para>This command assumes that you have already completed
|
||||
<xref linkend="security-mysql-account-root"/>.
|
||||
</para>
|
||||
</callout>
|
||||
</calloutlist>
|
||||
</example>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="security-mysql-network">
|
||||
<title>Network Access</title>
|
||||
|
||||
<para>If MySQL and your web server both run on the same machine and you
|
||||
have no other reason to access MySQL remotely, then you should disable
|
||||
the network access. This, along with the suggestion in
|
||||
<xref linkend="security-os-ports"/>, will help protect your system from
|
||||
any remote vulnerabilities in MySQL.
|
||||
</para>
|
||||
|
||||
<example id="security-mysql-network-ex">
|
||||
<title>Disabling Networking in MySQL</title>
|
||||
|
||||
<para>Simply enter the following in <filename>/etc/my.cnf</filename>:
|
||||
<screen>
|
||||
[mysqld]
|
||||
# Prevent network access to MySQL.
|
||||
skip-networking
|
||||
</screen>
|
||||
</para>
|
||||
</example>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<!-- For possible addition in the future: How to better control the bugs user
|
||||
<section id="security-mysql-bugs">
|
||||
<title>The bugs User</title>
|
||||
|
||||
</section>
|
||||
-->
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<section id="security-webserver">
|
||||
<title>Web server</title>
|
||||
|
||||
<section id="security-webserver-access">
|
||||
<title>Disabling Remote Access to Bugzilla Configuration Files</title>
|
||||
|
||||
<para>
|
||||
There are many files that are placed in the Bugzilla directory
|
||||
area that should not be accessible from the web server. Because of the way
|
||||
Bugzilla is currently layed out, the list of what should and should not
|
||||
be accessible is rather complicated. A quick way is to run
|
||||
<filename>testserver.pl</filename> to check if your web server serves
|
||||
Bugzilla files as expected. If not, you may want to follow the few
|
||||
steps below.
|
||||
</para>
|
||||
|
||||
<tip>
|
||||
<para>Bugzilla ships with the ability to create
|
||||
<glossterm linkend="gloss-htaccess"><filename>.htaccess</filename></glossterm>
|
||||
files that enforce these rules. Instructions for enabling these
|
||||
directives in Apache can be found in <xref linkend="http-apache"/>
|
||||
</para>
|
||||
</tip>
|
||||
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>In the main Bugzilla directory, you should:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block:
|
||||
<simplelist type="inline">
|
||||
<member><filename>*.pl</filename></member>
|
||||
<member><filename>*localconfig*</filename></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>In <filename class="directory">data</filename>:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>In <filename class="directory">data/webdot</filename>:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>If you use a remote webdot server:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>But allow
|
||||
<simplelist type="inline">
|
||||
<member><filename>*.dot</filename></member>
|
||||
</simplelist>
|
||||
only for the remote webdot server</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Otherwise, if you use a local GraphViz:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>But allow:
|
||||
<simplelist type="inline">
|
||||
<member><filename>*.png</filename></member>
|
||||
<member><filename>*.gif</filename></member>
|
||||
<member><filename>*.jpg</filename></member>
|
||||
<member><filename>*.map</filename></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>And if you don't use any dot:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>In <filename class="directory">Bugzilla</filename>:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>In <filename class="directory">template</filename>:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Block everything</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>Be sure to test that data that should not be accessed remotely is
|
||||
properly blocked. Of particular interest is the localconfig file which
|
||||
contains your database password. Also, be aware that many editors
|
||||
create temporary and backup files in the working directory and that
|
||||
those should also not be accessible. For more information, see
|
||||
<ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=186383">bug 186383</ulink>
|
||||
or
|
||||
<ulink url="http://online.securityfocus.com/bid/6501">Bugtraq ID 6501</ulink>.
|
||||
To test, simply run <filename>testserver.pl</filename>, as said above.
|
||||
</para>
|
||||
|
||||
<tip>
|
||||
<para>Be sure to check <xref linkend="http"/> for instructions
|
||||
specific to the web server you use.
|
||||
</para>
|
||||
</tip>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="security-bugzilla">
|
||||
<title>Bugzilla</title>
|
||||
|
||||
<section id="security-bugzilla-charset">
|
||||
<title>Prevent users injecting malicious Javascript</title>
|
||||
|
||||
<para>If you installed Bugzilla version 2.22 or later from scratch,
|
||||
then the <emphasis>utf8</emphasis> parameter is switched on by default.
|
||||
This makes Bugzilla explicitly set the character encoding, following
|
||||
<ulink
|
||||
url="http://www.cert.org/tech_tips/malicious_code_mitigation.html#3">a
|
||||
CERT advisory</ulink> recommending exactly this.
|
||||
The following therefore does not apply to you; just keep
|
||||
<emphasis>utf8</emphasis> turned on.
|
||||
</para>
|
||||
|
||||
<para>If you've upgraded from an older version, then it may be possible
|
||||
for a Bugzilla user to take advantage of character set encoding
|
||||
ambiguities to inject HTML into Bugzilla comments.
|
||||
This could include malicious scripts.
|
||||
This is because due to internationalization concerns, we are unable to
|
||||
turn the <emphasis>utf8</emphasis> parameter on by default for upgraded
|
||||
installations.
|
||||
Turning it on manually will prevent this problem.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
</chapter>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End: -->
|
||||
|
||||
@@ -1,311 +0,0 @@
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % myents SYSTEM "bugzilla.ent">
|
||||
%myents;
|
||||
]>
|
||||
<!-- $Id: troubleshooting.xml,v 1.13.4.1 2008-07-13 16:44:28 mozilla%colinogilvie.co.uk Exp $ -->
|
||||
|
||||
<appendix id="troubleshooting">
|
||||
<title>Troubleshooting</title>
|
||||
|
||||
<para>This section gives solutions to common Bugzilla installation
|
||||
problems. If none of the section headings seems to match your
|
||||
problem, read the general advice.
|
||||
</para>
|
||||
|
||||
<section id="general-advice">
|
||||
<title>General Advice</title>
|
||||
<para>If you can't get <filename>checksetup.pl</filename> to run to
|
||||
completion, it normally explains what's wrong and how to fix it.
|
||||
If you can't work it out, or if it's being uncommunicative, post
|
||||
the errors in the
|
||||
<ulink url="news://news.mozilla.org/mozilla.support.bugzilla">mozilla.support.bugzilla</ulink>
|
||||
newsgroup.
|
||||
</para>
|
||||
|
||||
<para>If you have made it all the way through
|
||||
<xref linkend="installation"/> (Installation) and
|
||||
<xref linkend="configuration"/> (Configuration) but accessing the Bugzilla
|
||||
URL doesn't work, the first thing to do is to check your web server error
|
||||
log. For Apache, this is often located at
|
||||
<filename>/etc/logs/httpd/error_log</filename>. The error messages
|
||||
you see may be self-explanatory enough to enable you to diagnose and
|
||||
fix the problem. If not, see below for some commonly-encountered
|
||||
errors. If that doesn't help, post the errors to the newsgroup.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Bugzilla can also log all user-based errors (and many code-based errors)
|
||||
that occur, without polluting the web server's error log. To enable
|
||||
Bugzilla error logging, create a file that Bugzilla can write to, named
|
||||
<filename>errorlog</filename>, in the Bugzilla <filename>data</filename>
|
||||
directory. Errors will be logged as they occur, and will include the type
|
||||
of the error, the IP address and username (if available) of the user who
|
||||
triggered the error, and the values of all environment variables; if a
|
||||
form was being submitted, the data in the form will also be included.
|
||||
To disable error logging, delete or rename the
|
||||
<filename>errorlog</filename> file.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="trbl-testserver">
|
||||
<title>The Apache web server is not serving Bugzilla pages</title>
|
||||
<para>After you have run <command>checksetup.pl</command> twice,
|
||||
run <command>testserver.pl http://yoursite.yourdomain/yoururl</command>
|
||||
to confirm that your web server is configured properly for
|
||||
Bugzilla.
|
||||
</para>
|
||||
<programlisting>
|
||||
<prompt>bash$</prompt> ./testserver.pl http://landfill.bugzilla.org/bugzilla-tip
|
||||
TEST-OK Webserver is running under group id in $webservergroup.
|
||||
TEST-OK Got ant picture.
|
||||
TEST-OK Webserver is executing CGIs.
|
||||
TEST-OK Webserver is preventing fetch of http://landfill.bugzilla.org/bugzilla-tip/localconfig.
|
||||
</programlisting>
|
||||
</section>
|
||||
|
||||
<section id="trbl-perlmodule">
|
||||
<title>I installed a Perl module, but
|
||||
<filename>checksetup.pl</filename> claims it's not installed!</title>
|
||||
|
||||
<para>This could be caused by one of two things:</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>You have two versions of Perl on your machine. You are installing
|
||||
modules into one, and Bugzilla is using the other. Rerun the CPAN
|
||||
commands (or manual compile) using the full path to Perl from the
|
||||
top of <filename>checksetup.pl</filename>. This will make sure you
|
||||
are installing the modules in the right place.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The permissions on your library directories are set incorrectly.
|
||||
They must, at the very least, be readable by the web server user or
|
||||
group. It is recommended that they be world readable.
|
||||
</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</section>
|
||||
|
||||
<section id="trbl-dbdSponge">
|
||||
<title>DBD::Sponge::db prepare failed</title>
|
||||
|
||||
<para>The following error message may appear due to a bug in DBD::mysql
|
||||
(over which the Bugzilla team have no control):
|
||||
</para>
|
||||
|
||||
<programlisting><![CDATA[ DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site/lib/DBD/mysql.pm line 248.
|
||||
SV = NULL(0x0) at 0x20fc444
|
||||
REFCNT = 1
|
||||
FLAGS = (PADBUSY,PADMY)
|
||||
]]></programlisting>
|
||||
|
||||
<para>To fix this, go to
|
||||
<filename><path-to-perl>/lib/DBD/sponge.pm</filename>
|
||||
in your Perl installation and replace
|
||||
</para>
|
||||
|
||||
<programlisting><![CDATA[ my $numFields;
|
||||
if ($attribs->{'NUM_OF_FIELDS'}) {
|
||||
$numFields = $attribs->{'NUM_OF_FIELDS'};
|
||||
} elsif ($attribs->{'NAME'}) {
|
||||
$numFields = @{$attribs->{NAME}};
|
||||
]]></programlisting>
|
||||
|
||||
<para>with</para>
|
||||
|
||||
<programlisting><![CDATA[ my $numFields;
|
||||
if ($attribs->{'NUM_OF_FIELDS'}) {
|
||||
$numFields = $attribs->{'NUM_OF_FIELDS'};
|
||||
} elsif ($attribs->{'NAMES'}) {
|
||||
$numFields = @{$attribs->{NAMES}};
|
||||
]]></programlisting>
|
||||
|
||||
<para>(note the S added to NAME.)</para>
|
||||
</section>
|
||||
|
||||
<section id="paranoid-security">
|
||||
<title>cannot chdir(/var/spool/mqueue)</title>
|
||||
|
||||
<para>If you are installing Bugzilla on SuSE Linux, or some other
|
||||
distributions with <quote>paranoid</quote> security options, it is
|
||||
possible that the checksetup.pl script may fail with the error:
|
||||
<programlisting><![CDATA[cannot chdir(/var/spool/mqueue): Permission denied
|
||||
]]></programlisting>
|
||||
</para>
|
||||
|
||||
<para>This is because your <filename>/var/spool/mqueue</filename>
|
||||
directory has a mode of <computeroutput>drwx------</computeroutput>.
|
||||
Type <command>chmod 755 <filename>/var/spool/mqueue</filename></command>
|
||||
as root to fix this problem. This will allow any process running on your
|
||||
machine the ability to <emphasis>read</emphasis> the
|
||||
<filename>/var/spool/mqueue</filename> directory.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="trbl-relogin-everyone">
|
||||
<title>Everybody is constantly being forced to relogin</title>
|
||||
|
||||
<para>The most-likely cause is that the <quote>cookiepath</quote> parameter
|
||||
is not set correctly in the Bugzilla configuration. You can change this (if
|
||||
you're a Bugzilla administrator) from the editparams.cgi page via the web interface.
|
||||
</para>
|
||||
|
||||
<para>The value of the cookiepath parameter should be the actual directory
|
||||
containing your Bugzilla installation, <emphasis>as seen by the end-user's
|
||||
web browser</emphasis>. Leading and trailing slashes are mandatory. You can
|
||||
also set the cookiepath to any directory which is a parent of the Bugzilla
|
||||
directory (such as '/', the root directory). But you can't put something
|
||||
that isn't at least a partial match or it won't work. What you're actually
|
||||
doing is restricting the end-user's browser to sending the cookies back only
|
||||
to that directory.
|
||||
</para>
|
||||
|
||||
<para>How do you know if you want your specific Bugzilla directory or the
|
||||
whole site?
|
||||
</para>
|
||||
|
||||
<para>If you have only one Bugzilla running on the server, and you don't
|
||||
mind having other applications on the same server with it being able to see
|
||||
the cookies (you might be doing this on purpose if you have other things on
|
||||
your site that share authentication with Bugzilla), then you'll want to have
|
||||
the cookiepath set to "/", or to a sufficiently-high enough directory that
|
||||
all of the involved apps can see the cookies.
|
||||
</para>
|
||||
|
||||
<example id="trbl-relogin-everyone-share">
|
||||
<title>Examples of urlbase/cookiepath pairs for sharing login cookies</title>
|
||||
|
||||
<blockquote>
|
||||
<literallayout>
|
||||
urlbase is <ulink url="http://bugzilla.mozilla.org/"/>
|
||||
cookiepath is /
|
||||
|
||||
urlbase is <ulink url="http://tools.mysite.tld/bugzilla/"/>
|
||||
but you have http://tools.mysite.tld/someotherapp/ which shares
|
||||
authentication with your Bugzilla
|
||||
cookiepath is /
|
||||
</literallayout>
|
||||
</blockquote>
|
||||
</example>
|
||||
|
||||
<para>On the other hand, if you have more than one Bugzilla running on the
|
||||
server (some people do - we do on landfill) then you need to have the
|
||||
cookiepath restricted enough so that the different Bugzillas don't
|
||||
confuse their cookies with one another.
|
||||
</para>
|
||||
|
||||
|
||||
<example id="trbl-relogin-everyone-restrict">
|
||||
<title>Examples of urlbase/cookiepath pairs to restrict the login cookie</title>
|
||||
<blockquote>
|
||||
<literallayout>
|
||||
urlbase is <ulink url="http://landfill.bugzilla.org/bugzilla-tip/"/>
|
||||
cookiepath is /bugzilla-tip/
|
||||
|
||||
urlbase is <ulink url="http://landfill.bugzilla.org/bugzilla-2.16-branch/"/>
|
||||
cookiepath is /bugzilla-2.16-branch/
|
||||
</literallayout>
|
||||
</blockquote>
|
||||
</example>
|
||||
|
||||
<para>If you had cookiepath set to <quote>/</quote> at any point in the
|
||||
past and need to set it to something more restrictive
|
||||
(i.e. <quote>/bugzilla/</quote>), you can safely do this without
|
||||
requiring users to delete their Bugzilla-related cookies in their
|
||||
browser (this is true starting with Bugzilla 2.18 and Bugzilla 2.16.5).
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="trbl-relogin-some">
|
||||
<title>Some users are constantly being forced to relogin</title>
|
||||
|
||||
<para>First, make sure cookies are enabled in the user's browser.
|
||||
</para>
|
||||
|
||||
<para>If that doesn't fix the problem, it may be that the user's ISP
|
||||
implements a rotating proxy server. This causes the user's effective IP
|
||||
address (the address which the Bugzilla server perceives him coming from)
|
||||
to change periodically. Since Bugzilla cookies are tied to a specific IP
|
||||
address, each time the effective address changes, the user will have to
|
||||
log in again.
|
||||
</para>
|
||||
|
||||
<para>If you are using 2.18 (or later), there is a
|
||||
parameter called <quote>loginnetmask</quote>, which you can use to set
|
||||
the number of bits of the user's IP address to require to be matched when
|
||||
authenticating the cookies. If you set this to something less than 32,
|
||||
then the user will be given a checkbox for <quote>Restrict this login to
|
||||
my IP address</quote> on the login screen, which defaults to checked. If
|
||||
they leave the box checked, Bugzilla will behave the same as it did
|
||||
before, requiring an exact match on their IP address to remain logged in.
|
||||
If they uncheck the box, then only the left side of their IP address (up
|
||||
to the number of bits you specified in the parameter) has to match to
|
||||
remain logged in.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="trbl-index">
|
||||
<title><filename>index.cgi</filename> doesn't show up unless specified in the URL</title>
|
||||
<para>
|
||||
You probably need to set up your web server in such a way that it
|
||||
will serve the index.cgi page as an index page.
|
||||
</para>
|
||||
<para>
|
||||
If you are using Apache, you can do this by adding
|
||||
<filename>index.cgi</filename> to the end of the
|
||||
<computeroutput>DirectoryIndex</computeroutput> line
|
||||
as mentioned in <xref linkend="http-apache"/>.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="trbl-passwd-encryption">
|
||||
<title>
|
||||
checksetup.pl reports "Client does not support authentication protocol
|
||||
requested by server..."
|
||||
</title>
|
||||
|
||||
<para>
|
||||
This error is occurring because you are using the new password
|
||||
encryption that comes with MySQL 4.1, while your
|
||||
<filename>DBD::mysql</filename> module was compiled against an
|
||||
older version of MySQL. If you recompile <filename>DBD::mysql</filename>
|
||||
against the current MySQL libraries (or just obtain a newer version
|
||||
of this module) then the error may go away.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If that does not fix the problem, or if you cannot recompile the
|
||||
existing module (e.g. you're running Windows) and/or don't want to
|
||||
replace it (e.g. you want to keep using a packaged version), then a
|
||||
workaround is available from the MySQL docs:
|
||||
<ulink url="http://dev.mysql.com/doc/mysql/en/Old_client.html"/>
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
</appendix>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-auto-insert-required-elements:t
|
||||
sgml-balanced-tag-edit:t
|
||||
sgml-exposed-tags:nil
|
||||
sgml-general-insert-case:lower
|
||||
sgml-indent-data:t
|
||||
sgml-indent-step:2
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-namecase-general:t
|
||||
sgml-omittag:t
|
||||
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
|
||||
sgml-shorttag:t
|
||||
sgml-tag-region-if-active:t
|
||||
End: -->
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,217 +0,0 @@
|
||||
#!/usr/bin/perl -w
|
||||
# -*- Mode: perl; indent-tabs-mode: nil -*-
|
||||
#
|
||||
# The contents of this file are subject to the Mozilla Public
|
||||
# License Version 1.1 (the "License"); you may not use this file
|
||||
# except in compliance with the License. You may obtain a copy of
|
||||
# the License at http://www.mozilla.org/MPL/
|
||||
#
|
||||
# Software distributed under the License is distributed on an "AS
|
||||
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
||||
# implied. See the License for the specific language governing
|
||||
# rights and limitations under the License.
|
||||
#
|
||||
# The Original Code is the Bugzilla Bug Tracking System.
|
||||
#
|
||||
# The Initial Developer of the Original Code is Netscape Communications
|
||||
# Corporation. Portions created by Netscape are
|
||||
# Copyright (C) 1998 Netscape Communications Corporation. All
|
||||
# Rights Reserved.
|
||||
#
|
||||
# Contributor(s): Matthew Tuck <matty@chariot.net.au>
|
||||
# Jacob Steenhagen <jake@bugzilla.org>
|
||||
# Colin Ogilvie <colin.ogilvie@gmail.com>
|
||||
# Max Kanat-Alexander <mkanat@bugzilla.org>
|
||||
|
||||
# This script compiles all the documentation.
|
||||
|
||||
use strict;
|
||||
use Cwd;
|
||||
|
||||
# We need to be in this directory to use our libraries.
|
||||
BEGIN {
|
||||
require File::Basename;
|
||||
import File::Basename qw(dirname);
|
||||
chdir dirname($0);
|
||||
}
|
||||
|
||||
use lib qw(.. ../lib lib);
|
||||
|
||||
# We only compile our POD if Pod::Simple is installed. We do the checks
|
||||
# this way so that if there's a compile error in Pod::Simple::HTML::Bugzilla,
|
||||
# makedocs doesn't just silently fail, but instead actually tells us there's
|
||||
# a compile error.
|
||||
my $pod_simple;
|
||||
if (eval { require Pod::Simple }) {
|
||||
require Pod::Simple::HTMLBatch::Bugzilla;
|
||||
require Pod::Simple::HTML::Bugzilla;
|
||||
$pod_simple = 1;
|
||||
};
|
||||
|
||||
use Bugzilla::Install::Requirements
|
||||
qw(REQUIRED_MODULES OPTIONAL_MODULES);
|
||||
use Bugzilla::Constants qw(DB_MODULE BUGZILLA_VERSION);
|
||||
|
||||
###############################################################################
|
||||
# Generate minimum version list
|
||||
###############################################################################
|
||||
|
||||
my $modules = REQUIRED_MODULES;
|
||||
my $opt_modules = OPTIONAL_MODULES;
|
||||
|
||||
open(ENTITIES, '>', 'bugzilla.ent') or die('Could not open bugzilla.ent: ' . $!);
|
||||
print ENTITIES <<END_ENTITIES;
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
|
||||
<!ENTITY bz-ver "3.3">
|
||||
<!ENTITY bz-nextver "4.0">
|
||||
<!ENTITY bz-date "2008-05-20">
|
||||
<!ENTITY current-year "2008">
|
||||
|
||||
<!ENTITY landfillbase "http://landfill.bugzilla.org/bugzilla-tip/">
|
||||
<!ENTITY bz "http://www.bugzilla.org/">
|
||||
<!ENTITY bzg-bugs "<ulink url='https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation'>Bugzilla Documentation</ulink>">
|
||||
<!ENTITY mysql "http://www.mysql.com/">
|
||||
|
||||
<!ENTITY min-perl-ver "5.8.1">
|
||||
|
||||
|
||||
<!-- Module Versions -->
|
||||
END_ENTITIES
|
||||
foreach my $module (@$modules, @$opt_modules)
|
||||
{
|
||||
my $name = $module->{'module'};
|
||||
$name =~ s/::/-/g;
|
||||
$name = lc($name);
|
||||
#This needs to be a string comparison, due to the modules having
|
||||
#version numbers like 0.9.4
|
||||
my $version = $module->{'version'} eq 0 ? 'any' : $module->{'version'};
|
||||
print ENTITIES '<!ENTITY min-' . $name . '-ver "'.$version.'">' . "\n";
|
||||
}
|
||||
|
||||
# CGI is a special case, because for Perl versions below 5.10, it has an
|
||||
# optional version *and* a required version.
|
||||
# We check @opt_modules first, then @modules, and pick the first we get.
|
||||
# We'll get the optional one then, if it is given, otherwise the required one.
|
||||
my ($cgi_opt) = grep($_->{module} eq 'CGI', @$opt_modules, @$modules);
|
||||
print ENTITIES '<!ENTITY min-mp-cgi-ver "' . $cgi_opt->{version} . '">' . "\n";
|
||||
|
||||
print ENTITIES "\n <!-- Database Versions --> \n";
|
||||
|
||||
my $db_modules = DB_MODULE;
|
||||
foreach my $db (keys %$db_modules) {
|
||||
my $dbd = $db_modules->{$db}->{dbd};
|
||||
my $name = $dbd->{module};
|
||||
$name =~ s/::/-/g;
|
||||
$name = lc($name);
|
||||
my $version = $dbd->{version} || 'any';
|
||||
my $db_version = $db_modules->{$db}->{'db_version'};
|
||||
print ENTITIES '<!ENTITY min-' . $name . '-ver "'.$version.'">' . "\n";
|
||||
print ENTITIES '<!ENTITY min-' . lc($db) . '-ver "'.$db_version.'">' . "\n";
|
||||
}
|
||||
close(ENTITIES);
|
||||
|
||||
###############################################################################
|
||||
# Subs
|
||||
###############################################################################
|
||||
|
||||
sub MakeDocs {
|
||||
|
||||
my ($name, $cmdline) = @_;
|
||||
|
||||
print "Creating $name documentation ...\n" if defined $name;
|
||||
print "$cmdline\n\n";
|
||||
system $cmdline;
|
||||
print "\n";
|
||||
|
||||
}
|
||||
|
||||
sub make_pod {
|
||||
|
||||
print "Creating API documentation...\n";
|
||||
|
||||
my $converter = Pod::Simple::HTMLBatch::Bugzilla->new;
|
||||
# Don't output progress information.
|
||||
$converter->verbose(0);
|
||||
$converter->html_render_class('Pod::Simple::HTML::Bugzilla');
|
||||
|
||||
my $doctype = Pod::Simple::HTML::Bugzilla->DOCTYPE;
|
||||
my $content_type = Pod::Simple::HTML::Bugzilla->META_CT;
|
||||
my $bz_version = BUGZILLA_VERSION;
|
||||
|
||||
my $contents_start = <<END_HTML;
|
||||
$doctype
|
||||
<html>
|
||||
<head>
|
||||
$content_type
|
||||
<title>Bugzilla $bz_version API Documentation</title>
|
||||
</head>
|
||||
<body class="contentspage">
|
||||
<h1>Bugzilla $bz_version API Documentation</h1>
|
||||
END_HTML
|
||||
|
||||
$converter->contents_page_start($contents_start);
|
||||
$converter->contents_page_end("</body></html>");
|
||||
$converter->add_css('./../../../style.css');
|
||||
$converter->javascript_flurry(0);
|
||||
$converter->css_flurry(0);
|
||||
$converter->batch_convert(['../../'], 'html/api/');
|
||||
|
||||
print "\n";
|
||||
}
|
||||
|
||||
###############################################################################
|
||||
# Make the docs ...
|
||||
###############################################################################
|
||||
|
||||
my @langs;
|
||||
# search for sub directories which have a 'xml' sub-directory
|
||||
opendir(LANGS, './');
|
||||
foreach my $dir (readdir(LANGS)) {
|
||||
next if (($dir eq '.') || ($dir eq '..') || (! -d $dir));
|
||||
if (-d "$dir/xml") {
|
||||
push(@langs, $dir);
|
||||
}
|
||||
}
|
||||
closedir(LANGS);
|
||||
|
||||
my $docparent = getcwd();
|
||||
foreach my $lang (@langs) {
|
||||
chdir "$docparent/$lang";
|
||||
MakeDocs(undef, 'cp ../bugzilla.ent ./xml/');
|
||||
|
||||
if (!-d 'txt') {
|
||||
unlink 'txt';
|
||||
mkdir 'txt', 0755;
|
||||
}
|
||||
if (!-d 'pdf') {
|
||||
unlink 'pdf';
|
||||
mkdir 'pdf', 0755;
|
||||
}
|
||||
if (!-d 'html') {
|
||||
unlink 'html';
|
||||
mkdir 'html', 0755;
|
||||
}
|
||||
if (!-d 'html/api') {
|
||||
unlink 'html/api';
|
||||
mkdir 'html/api', 0755;
|
||||
}
|
||||
|
||||
MakeDocs(undef, 'cp ../style.css html/api/');
|
||||
|
||||
make_pod() if $pod_simple;
|
||||
|
||||
MakeDocs('separate HTML', 'xmlto -m ../xsl/chunks.xsl -o html html ' .
|
||||
'xml/Bugzilla-Guide.xml');
|
||||
MakeDocs('big HTML', 'xmlto -m ../xsl/nochunks.xsl -o html html-nochunks ' .
|
||||
'xml/Bugzilla-Guide.xml');
|
||||
MakeDocs('big text', "lynx -dump -justify=off -nolist html/Bugzilla-Guide.html " .
|
||||
"> txt/Bugzilla-Guide.txt");
|
||||
|
||||
if (! grep($_ eq "--with-pdf", @ARGV)) {
|
||||
next;
|
||||
}
|
||||
|
||||
MakeDocs('PDF', 'xmlto -m ../xsl/pdf.xsl -o pdf pdf xml/Bugzilla-Guide.xml');
|
||||
}
|
||||
|
||||
@@ -1,112 +0,0 @@
|
||||
/* The contents of this file are subject to the Mozilla Public
|
||||
* License Version 1.1 (the "License"); you may not use this file
|
||||
* except in compliance with the License. You may obtain a copy of
|
||||
* the License at http://www.mozilla.org/MPL/
|
||||
*
|
||||
* Software distributed under the License is distributed on an "AS
|
||||
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
||||
* implied. See the License for the specific language governing
|
||||
* rights and limitations under the License.
|
||||
*
|
||||
* The Original Code is the Bugzilla Bug Tracking System.
|
||||
*
|
||||
* The Initial Developer of the Original Code is Everything Solved.
|
||||
* Portions created by Everything Solved are Copyright (C) 2006
|
||||
* Everything Solved. All Rights Reserved.
|
||||
*
|
||||
* Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
|
||||
*/
|
||||
|
||||
body {
|
||||
background: white;
|
||||
color: #111;
|
||||
padding: 0 1em;
|
||||
margin: 0;
|
||||
font-family: Verdana, Arial, sans-serif;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
td, th {
|
||||
font-family: Verdana, Arial, sans-serif;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
a:link, a:active { color: #36415c; }
|
||||
a:visited { color: #666; }
|
||||
a:hover { color: #888; }
|
||||
|
||||
h1 {
|
||||
font-size: 150%;
|
||||
font-weight: bold;
|
||||
border-bottom: 2px solid #ccc;
|
||||
}
|
||||
h2 {
|
||||
font-size: 125%;
|
||||
font-weight: bold;
|
||||
border-bottom: 1px solid #ccc;
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
h3 {
|
||||
font-size: 115%;
|
||||
font-weight: bold;
|
||||
margin-bottom: 0;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
/* This makes Description/Params/Returns look nice. */
|
||||
dd { margin-top: .2em; }
|
||||
dd p { margin-top: 0; }
|
||||
dl { margin-bottom: 1em; }
|
||||
|
||||
/* This makes the names of functions slightly larger, in Gecko. */
|
||||
body > dl > dt code { font-size: 1.35em; }
|
||||
|
||||
#pod h1 a, #pod h2 a, #pod h3 a {
|
||||
color: #36415c;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
pre, code, tt, kbd, samp {
|
||||
/* Unfortunately, the default monospace fonts on most browsers
|
||||
look odd with relative sizing. */
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
.code {
|
||||
background: #eed;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
pre.code {
|
||||
margin-left: 10px;
|
||||
width: 90%;
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
/* Special styles for the Contents page */
|
||||
|
||||
.contentspage dt {
|
||||
font-size: large;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.pod_desc_table {
|
||||
border-collapse: collapse;
|
||||
table-layout: auto;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
.pod_desc_table th {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.pod_desc_table td, .pod_desc_table th {
|
||||
padding: .25em;
|
||||
border-top: 1px solid #ccc;
|
||||
}
|
||||
|
||||
.pod_desc_table .odd th, .pod_desc_table .odd td {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
.pod_desc_table
|
||||
@@ -1,102 +0,0 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
|
||||
<!-- Nicer Filenames -->
|
||||
<xsl:param name="use.id.as.filename" select="1"/>
|
||||
|
||||
<!-- Label sections if they aren't automatically labeled -->
|
||||
<xsl:param name="section.autolabel" select="1"/>
|
||||
|
||||
<!-- Table of Contents Depth -->
|
||||
<xsl:param name="toc.section.depth">1</xsl:param>
|
||||
|
||||
<!-- Set chunk parameters -->
|
||||
<xsl:param name="chunk.section.depth" select="1"/>
|
||||
<xsl:param name="chunk.first.sections" select="1"/>
|
||||
<xsl:param name="chunker.output.encoding" select="UTF-8"/>
|
||||
|
||||
<!-- Show titles of next/previous page -->
|
||||
<xsl:param name="navig.showtitles">1</xsl:param>
|
||||
|
||||
<!-- Tidy up the HTML a bit... -->
|
||||
<xsl:param name="html.cleanup" select="1"/>
|
||||
<xsl:param name="make.valid.html" select="1"/>
|
||||
<xsl:param name="html.stylesheet">api/style.css</xsl:param>
|
||||
<!-- make links nicer... -->
|
||||
<xsl:param name="refentry.generate.title" select="1"/>
|
||||
<xsl:param name="refentry.generate.name" select="0"/>
|
||||
|
||||
<!-- Use Graphics, specify their Path and Extension -->
|
||||
<xsl:param name="admon.graphics" select="1"/>
|
||||
<xsl:param name="admon.graphics.path">../images/</xsl:param>
|
||||
<xsl:param name="admon.graphics.extension">.gif</xsl:param>
|
||||
|
||||
<xsl:param name="qanda.inherit.numeration" select="0" />
|
||||
|
||||
<!--
|
||||
****
|
||||
CODE BELOW HERE IS EXTRACTED AND EDITED FROM THE DOCBOOK XSL SOURCES
|
||||
****
|
||||
-->
|
||||
|
||||
<xsl:template match="simplelist[@type='inline']/member">
|
||||
<xsl:apply-templates/>
|
||||
</xsl:template>
|
||||
|
||||
<!--
|
||||
To generate valid HTML, we need to redefine this section... Code extracted from
|
||||
http://cvs.sourceforge.net/viewcvs.py/docbook/xsl/html/qandaset.xsl?rev=1.19&view=log
|
||||
|
||||
and modified below. Basic change: Remove the colspan attribute of the tr tags - no
|
||||
other changes have been made to the document.
|
||||
-->
|
||||
|
||||
<xsl:template match="qandadiv">
|
||||
<xsl:variable name="preamble" select="*[name(.) != 'title'
|
||||
and name(.) != 'titleabbrev'
|
||||
and name(.) != 'qandadiv'
|
||||
and name(.) != 'qandaentry']"/>
|
||||
|
||||
<xsl:if test="blockinfo/title|title">
|
||||
<tr class="qandadiv">
|
||||
<td align="left" valign="top" colspan="2">
|
||||
<xsl:call-template name="anchor">
|
||||
<xsl:with-param name="conditional" select="0"/>
|
||||
</xsl:call-template>
|
||||
<xsl:apply-templates select="(blockinfo/title|title)[1]"/>
|
||||
</td>
|
||||
</tr>
|
||||
</xsl:if>
|
||||
|
||||
<xsl:variable name="toc">
|
||||
<xsl:call-template name="dbhtml-attribute">
|
||||
<xsl:with-param name="pis"
|
||||
select="processing-instruction('dbhtml')"/>
|
||||
<xsl:with-param name="attribute" select="'toc'"/>
|
||||
</xsl:call-template>
|
||||
</xsl:variable>
|
||||
|
||||
<xsl:variable name="toc.params">
|
||||
<xsl:call-template name="find.path.params">
|
||||
<xsl:with-param name="table" select="normalize-space($generate.toc)"/>
|
||||
</xsl:call-template>
|
||||
</xsl:variable>
|
||||
|
||||
<xsl:if test="(contains($toc.params, 'toc') and $toc != '0') or $toc = '1'">
|
||||
<tr class="toc">
|
||||
<td align="left" valign="top" colspan="2">
|
||||
<xsl:call-template name="process.qanda.toc"/>
|
||||
</td>
|
||||
</tr>
|
||||
</xsl:if>
|
||||
<xsl:if test="$preamble">
|
||||
<tr class="toc" >
|
||||
<td align="left" valign="top" colspan="2">
|
||||
<xsl:apply-templates select="$preamble"/>
|
||||
</td>
|
||||
</tr>
|
||||
</xsl:if>
|
||||
<xsl:apply-templates select="qandadiv|qandaentry"/>
|
||||
</xsl:template>
|
||||
</xsl:stylesheet>
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
<!-- Include default bugzilla XSL -->
|
||||
<xsl:include href="bugzilla-docs.xsl"/>
|
||||
<!-- Set Chunk Specific XSL Params -->
|
||||
<xsl:param name="chunker.output.doctype-public">-//W3C//DTD HTML 4.01 Transitional//EN</xsl:param>
|
||||
<xsl:param name="chunker.output.doctype-system">http://www.w3.org/TR/html4/loose.dtd</xsl:param>
|
||||
<xsl:param name="chunk.section.depth" select="1"/>
|
||||
<xsl:param name="chunk.first.sections" select="1"/>
|
||||
<!-- Don't output filename list - mimic old behaviour-->
|
||||
<xsl:param name="chunk.quietly" select="0" />
|
||||
</xsl:stylesheet>
|
||||
@@ -1,6 +0,0 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
<!-- Include default bugzilla XSL -->
|
||||
<xsl:include href="bugzilla-docs.xsl"/>
|
||||
<!-- No other params necessary -->
|
||||
</xsl:stylesheet>
|
||||
@@ -1,19 +0,0 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
|
||||
<!-- Enable passivetex extensions -->
|
||||
<xsl:param name="passivetex.extensions" select="1"/>
|
||||
<xsl:param name="tablecolumns.extensions" select="1"/>
|
||||
|
||||
<!-- Show <ulink>s as footnotes -->
|
||||
<xsl:param name="ulink.footnotes" select="1" />
|
||||
<xsl:param name="ulink.show" select="1" />
|
||||
|
||||
<!-- Don't use Graphics -->
|
||||
<xsl:param name="admon.graphics" select="0"/>
|
||||
<xsl:param name="callout.graphics" select="'0'"/>
|
||||
|
||||
<xsl:template match="simplelist[@type='inline']/member">
|
||||
<xsl:apply-templates/>
|
||||
</xsl:template>
|
||||
|
||||
</xsl:stylesheet>
|
||||
Reference in New Issue
Block a user