/usr/share/ada/adainclude/aws/aws-log.ads is in libaws2.10.2-dev 2.10.2-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | ------------------------------------------------------------------------------
-- Ada Web Server --
-- --
-- Copyright (C) 2000-2012, AdaCore --
-- --
-- This library is free software; you can redistribute it and/or modify --
-- it under the terms of the GNU General Public License as published by --
-- the Free Software Foundation; either version 2 of the License, or (at --
-- your option) any later version. --
-- --
-- This library is distributed in the hope that it will be useful, but --
-- WITHOUT ANY WARRANTY; without even the implied warranty of --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU --
-- General Public License for more details. --
-- --
-- You should have received a copy of the GNU General Public License --
-- along with this library; if not, write to the Free Software Foundation, --
-- Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. --
-- --
------------------------------------------------------------------------------
-- This package handle the logging facility for AWS. The log file is named
-- '<progname>-Y-M-D.log' and is written by default in the directory where
-- the server is launched, see configuration file.
--
-- Note that this package is used internally by AWS to log server requests
-- but it can also be used by users to handle application's log.
--
-- This package is thread safe.
with Ada.Finalization;
with Ada.Text_IO;
with Ada.Strings.Unbounded;
with AWS.Containers.String_Vectors;
with AWS.Headers;
with AWS.Status;
with AWS.Response;
with AWS.Messages;
private with Ada.Containers.Indefinite_Ordered_Maps;
private with AWS.Utils;
package AWS.Log is
type Object is limited private;
-- A log object. It must be activated by calling Start below
type Split_Mode is (None, Each_Run, Daily, Monthly);
-- It specifies when to create a new log file.
-- None : all log info gets accumulated into the same file.
-- Each_Run : a new log file is created each time the server is started.
-- Daily : a new log file is created each day.
-- Monthly : a new log file is created each month.
type Fields_Table is private;
-- Type to keep record for Extended Log File Format
Empty_Fields_Table : constant Fields_Table;
Not_Specified : constant String;
procedure Start
(Log : in out Object;
Split : Split_Mode := None;
Size_Limit : Natural := 0;
File_Directory : String := Not_Specified;
Filename_Prefix : String := Not_Specified;
Auto_Flush : Boolean := False);
-- Activate server's activity logging. Split indicate the way the log file
-- should be created. If Size_Limit more than zero and size of log file
-- become more than Size_Limit, log file would be splitted. Filename_Prefix
-- is the log filename prefix. If it is not specified the default prefix is
-- the program name. Set Auto_Flush to True if you want every write to the
-- log to be flushed (not buffered). Auto_Flush should be set to True only
-- for logs with few entries per second as the flush has a performance
-- penalty.
procedure Register_Field (Log : in out Object; Id : String);
-- Register field to be written into extended log format
procedure Set_Field
(Log : Object; Data : in out Fields_Table; Id, Value : String);
-- Set field value into the extended log record. Data could be used only
-- in one task and with one log file. Different tasks could write own Data
-- using the Write routine with Fields_Table parameter type.
procedure Set_Header_Fields
(Log : Object;
Data : in out Fields_Table;
Prefix : String;
Header : AWS.Headers.List);
-- Set header fields into extended log record.
-- Name of the header fields would be <Prefix>(<Header_Name>).
-- Prefix should be "cs" - Client to Server or "sc" - Server to Client.
procedure Write (Log : in out Object; Data : in out Fields_Table);
-- Write extended format record to log file and prepare record for the next
-- data. It is not allowed to use same Fields_Table with different extended
-- logs.
procedure Write
(Log : in out Object;
Connect_Stat : Status.Data;
Answer : Response.Data);
-- Write log info if activated (i.e. Start routine above has been called)
procedure Write
(Log : in out Object;
Connect_Stat : Status.Data;
Status_Code : Messages.Status_Code;
Content_Length : Response.Content_Length_Type);
-- Write log info if activated (i.e. Start routine above has been called).
-- This version separated the Content_Length from Status.Data, this is
-- required for example in the case of a user defined stream content. See
-- AWS.Resources.Stream.
procedure Write
(Log : in out Object;
Connect_Stat : Status.Data;
Data : String);
-- Write user's log info if activated. (i.e. Start routine above has been
-- called).
procedure Write (Log : in out Object; Data : String);
-- Write Data into the log file. This Data is unstructured, only a time
-- tag prefix is prepended to Data. This routine is designed to be used
-- for user's info in error log file.
procedure Flush (Log : in out Object);
-- Flush the data to the Log file, for be able to see last logged
-- messages.
procedure Stop (Log : in out Object);
-- Stop logging activity
function Is_Active (Log : Object) return Boolean;
-- Returns True if Log is activated
function Filename (Log : Object) return String;
-- Returns current log filename or the empty string if the log is not
-- activated.
function Mode (Log : Object) return Split_Mode;
-- Returns the split mode. None will be returned if log is not activated
private
use Ada;
use Ada.Strings.Unbounded;
package Strings_Positive is
new Ada.Containers.Indefinite_Ordered_Maps (String, Positive);
package SV renames AWS.Containers.String_Vectors;
type Fields_Table is record
Values : SV.Vector;
end record;
Empty_Fields_Table : constant Fields_Table := (Values => SV.Empty_Vector);
Not_Specified : constant String := "";
type Object is new Ada.Finalization.Limited_Controlled with record
File : Text_IO.File_Type;
Extended_Fields : Strings_Positive.Map;
Header_Written : Boolean;
File_Directory : Unbounded_String;
Filename_Prefix : Unbounded_String;
Split : Split_Mode := None;
Size_Limit : Natural := 0;
Current_Tag : Positive;
Semaphore : Utils.Semaphore;
Auto_Flush : Boolean;
end record;
overriding procedure Finalize (Log : in out Object);
end AWS.Log;
|