/usr/share/ada/adainclude/aws/aws-config.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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 | ------------------------------------------------------------------------------
-- Ada Web Server --
-- --
-- Copyright (C) 2000-2011, 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 provide an easy way to handle server configuration options.
--
-- If initialization of this package is not done all functions below will
-- return the default value as declared in AWS.Default.
with Ada.Strings.Unbounded;
with AWS.Containers.String_Vectors;
with AWS.Default;
package AWS.Config is
use Ada.Strings.Unbounded;
type Object is private;
Default_Config : constant Object;
-- For the external configuration to be loaded either Get_Current or
-- Load_Config must be called explicitely.
function Get_Current return Object;
-- Returns a configuration record. This is the properties as read in files
-- 'aws.ini' and 'progname.ini'. This configuration object holds only the
-- per-server options.
procedure Load_Config;
-- Load configuration and store it into an internal object. This can be
-- called when only some server-wide configuration are to be set from
-- .ini files for example.
------------------------
-- Per Server options --
------------------------
------------
-- Server --
------------
function Server_Name (O : Object) return String;
pragma Inline (Server_Name);
-- This is the name of the server as set by AWS.Server.Start
function Server_Host (O : Object) return String;
pragma Inline (Server_Host);
-- This is the server host. Can be used if the computer has a more than
-- one IP address. It is possible to have two servers at the same port
-- on the same machine, both being binded on different IP addresses.
function Server_Port (O : Object) return Natural;
pragma Inline (Server_Port);
-- This is the server port as set by the HTTP object declaration
function Hotplug_Port (O : Object) return Positive;
pragma Inline (Hotplug_Port);
-- This is the hotplug communication port needed to register and
-- un-register an hotplug module.
function Session (O : Object) return Boolean;
pragma Inline (Session);
-- Returns True if the server session is activated
function Case_Sensitive_Parameters (O : Object) return Boolean;
pragma Inline (Case_Sensitive_Parameters);
-- HTTP parameters are case sensitive
function Session_Name (O : Object) return String;
pragma Inline (Session_Name);
-- Name of the cookie session
----------------
-- Connection --
----------------
function Max_Connection (O : Object) return Positive;
pragma Inline (Max_Connection);
-- This is the max simultaneous connections as set by the HTTP object
-- declaration.
function Send_Buffer_Size (O : Object) return Natural;
pragma Inline (Send_Buffer_Size);
-- This is the socket buffer size used for sending data. Increasing this
-- value will give better performances on slow or long distances
-- connections.
function Free_Slots_Keep_Alive_Limit (O : Object) return Natural;
pragma Inline (Free_Slots_Keep_Alive_Limit);
-- The minimum number of free slots where keep-alive connections are still
-- enabled. After this limit no more keep-alive connection will be
-- accepted by the server. This parameter must be used for heavy-loaded
-- servers to make sure the server will never run out of slots. This limit
-- must be less than Max_Connection.
function Keep_Alive_Force_Limit (O : Object) return Positive;
pragma Inline (Keep_Alive_Force_Limit);
-- Server could have more than Max_Connection keep-alive sockets. Keep
-- alive sockets are waiting for client input in the internal server socket
-- set. This parameter defines the maximum number of keep alive sockets
-- processed by the server with standard timeouts. If number of keep-alive
-- sockets becomes more than Keep_Alive_Force_Limit the server starts to
-- use shorter timeouts. If this parameter is not defined in the
-- configuration, the server uses Max_Connection * 2 as value.
function Keep_Alive_Close_Limit (O : Object) return Positive;
pragma Inline (Keep_Alive_Close_Limit);
-- This parameter defines the limit of keep alive sockets in the internal
-- server socket set. If the number of sockets in socket set became more
-- than Keep_Alive_Close_Limit, most close to timeout socket would be
-- closed. If this parameter is not defined in the configuration,
-- the server uses Max_Connection * 4 as value.
function Accept_Queue_Size (O : Object) return Positive;
pragma Inline (Accept_Queue_Size);
-- This is the size of the queue for the incoming requests. Higher this
-- value will be and less "connection refused" will be reported to the
-- client.
function Line_Stack_Size (O : Object) return Positive;
pragma Inline (Line_Stack_Size);
-- HTTP lines stack size
function Reuse_Address (O : Object) return Boolean;
pragma Inline (Reuse_Address);
-- Returns true if bind is allowed to reuse and address (not waiting for
-- the delay between two bind to the same port).
----------
-- Data --
----------
function WWW_Root (O : Object) return String;
pragma Inline (WWW_Root);
-- This is the root directory name for the server. This variable is not
-- used internally by AWS. It is supposed to be used by the callback
-- procedures who want to retrieve physical objects (images, Web pages...).
-- The default value is the current working directory. The returned
-- directory ends with a directory separator.
function Upload_Directory (O : Object) return String;
pragma Inline (Upload_Directory);
-- This point to the directory where uploaded files will be stored. The
-- directory returned will end with a directory separator.
function Upload_Size_Limit (O : Object) return Positive;
pragma Inline (Upload_Size_Limit);
function Directory_Browser_Page (O : Object) return String;
pragma Inline (Directory_Browser_Page);
-- Filename for the directory browser template page
function MIME_Types (O : Object) return String;
pragma Inline (MIME_Types);
-- Returns the name of the MIME types to use
---------
-- Log --
---------
function Log_File_Directory (O : Object) return String;
pragma Inline (Log_File_Directory);
-- This point to the directory where log files will be written. The
-- directory returned will end with a directory separator.
function Log_Filename_Prefix (O : Object) return String;
pragma Inline (Log_Filename_Prefix);
-- This is the prefix to use for the log filename
function Log_Split_Mode (O : Object) return String;
pragma Inline (Log_Split_Mode);
-- This is split mode for the log file. Possible values are : Each_Run,
-- Daily, Monthly and None. Any other values will raise an exception.
function Log_Size_Limit (O : Object) return Natural;
pragma Inline (Log_Size_Limit);
generic
with procedure Field_Id (Id : String);
procedure Log_Extended_Fields_Generic_Iterate (O : Object);
-- Calls procedure Field_Id for each extended http log field identifier
function Log_Extended_Fields_Length (O : Object) return Natural;
pragma Inline (Log_Extended_Fields_Length);
-- Returns the number of extended http log fileds identifiers.
-- If returned value is zero then http log is not extended.
function Error_Log_Filename_Prefix (O : Object) return String;
pragma Inline (Error_Log_Filename_Prefix);
-- This is the prefix to use for the log filename
function Error_Log_Split_Mode (O : Object) return String;
pragma Inline (Error_Log_Split_Mode);
-- This is split mode for the log file. Possible values are : Each_Run,
-- Daily, Monthly and None. Any other values will raise an exception.
------------
-- Status --
------------
function Admin_Password (O : Object) return String;
pragma Inline (Admin_Password);
-- The admin password
function Admin_Realm (O : Object) return String;
pragma Inline (Admin_Realm);
-- The admin password
function Admin_URI (O : Object) return String;
pragma Inline (Admin_URI);
-- This is the name of the admin server page as set by AWS.Server.Start.
-- It is also known as the status page.
function Status_Page (O : Object) return String;
pragma Inline (Status_Page);
-- Filename for the status template page
function Up_Image (O : Object) return String;
pragma Inline (Up_Image);
-- Filename for the up arrow image used in the status page
function Down_Image (O : Object) return String;
pragma Inline (Down_Image);
-- Filename for the down arrow image used in the status page
function Logo_Image (O : Object) return String;
pragma Inline (Logo_Image);
-- Filename for the AWS logo image used in the status page
--------------
-- Timeouts --
--------------
function Cleaner_Wait_For_Client_Timeout (O : Object) return Duration;
pragma Inline (Cleaner_Wait_For_Client_Timeout);
-- Number of seconds to timout on waiting for a client request.
-- This is a timeout for regular cleaning task.
function Cleaner_Client_Header_Timeout (O : Object) return Duration;
pragma Inline (Cleaner_Client_Header_Timeout);
-- Number of seconds to timout on waiting for client header.
-- This is a timeout for regular cleaning task.
function Cleaner_Client_Data_Timeout (O : Object) return Duration;
pragma Inline (Cleaner_Client_Data_Timeout);
-- Number of seconds to timout on waiting for client message body.
-- This is a timeout for regular cleaning task.
function Cleaner_Server_Response_Timeout (O : Object) return Duration;
pragma Inline (Cleaner_Server_Response_Timeout);
-- Number of seconds to timout on waiting for client to accept answer.
-- This is a timeout for regular cleaning task.
function Force_Wait_For_Client_Timeout (O : Object) return Duration;
pragma Inline (Force_Wait_For_Client_Timeout);
-- Number of seconds to timout on waiting for a client request.
-- This is a timeout for urgent request when resources are missing.
function Force_Client_Header_Timeout (O : Object) return Duration;
pragma Inline (Force_Client_Header_Timeout);
-- Number of seconds to timout on waiting for client header.
-- This is a timeout for urgent request when resources are missing.
function Force_Client_Data_Timeout (O : Object) return Duration;
pragma Inline (Force_Client_Data_Timeout);
-- Number of seconds to timout on waiting for client message body.
-- This is a timeout for urgent request when resources are missing.
function Force_Server_Response_Timeout (O : Object) return Duration;
pragma Inline (Force_Server_Response_Timeout);
-- Number of seconds to timout on waiting for client to accept answer.
-- This is a timeout for urgent request when resources are missing.
function Send_Timeout (O : Object) return Duration;
pragma Inline (Send_Timeout);
-- Number of seconds to timeout when sending chunck of data
function Receive_Timeout (O : Object) return Duration;
pragma Inline (Receive_Timeout);
-- Number of seconds to timeout when receiving chunck of data
--------------
-- Security --
--------------
function Check_URL_Validity (O : Object) return Boolean;
pragma Inline (Check_URL_Validity);
-- Server have to check URI for validity. For example it checks that an
-- URL does not reference a resource above the Web root.
function Security (O : Object) return Boolean;
pragma Inline (Security);
-- Is the server working through th SSL
function Certificate (O : Object) return String;
pragma Inline (Certificate);
-- Returns the certificate to be used with the secure server. Returns the
-- empty string if the server is not a secure one.
function Key (O : Object) return String;
pragma Inline (Key);
-- Returns the key to be used with the secure server. Returns the
-- empty string if the server is not a secure one.
function Security_Mode (O : Object) return String;
pragma Inline (Security_Mode);
-- Returns the security mode to be used with the secure server. Returns the
-- empty string if the server is not a secure one.
function Exchange_Certificate (O : Object) return Boolean;
pragma Inline (Exchange_Certificate);
-- Returns True if the client is requested to send its certificate to the
-- server. Note that this option must not be used if the client is a Web
-- Browser.
-------------------------
-- Per Process options --
-------------------------
function Session_Cleanup_Interval return Duration;
pragma Inline (Session_Cleanup_Interval);
-- Number of seconds between each run of the cleaner task to remove
-- obsolete session data.
function Session_Lifetime return Duration;
pragma Inline (Session_Lifetime);
-- Number of seconds to keep a session if not used. After this period the
-- session data is obsoleted and will be removed during next cleanup.
function Transient_Cleanup_Interval return Duration;
pragma Inline (Transient_Cleanup_Interval);
-- Number of seconds between each run of the cleaner task to remove
-- transient pages.
function Transient_Lifetime return Duration;
pragma Inline (Transient_Lifetime);
-- Number of seconds to keep a transient page. After this period the
-- transient page is obsoleted and will be removed during next cleanup.
function Max_Concurrent_Download return Positive;
pragma Inline (Max_Concurrent_Download);
-- Number of maximum concurrent download supported by the download manager
-- service.
function Input_Line_Size_Limit return Positive;
pragma Inline (Input_Line_Size_Limit);
-- Limit of the HTTP protocol text lines length
function Context_Lifetime return Duration;
pragma Inline (Context_Lifetime);
-- Number of seconds to keep a context if not used. After this period the
-- context data is obsoleted and will be removed during next cleanup.
private
package SV renames AWS.Containers.String_Vectors;
-- List of token (keyword) recognized by the parser. There must be one
-- entry for every option name to be handled.
type Parameter_Name is
-- Per server option
(Server_Name,
WWW_Root,
Admin_URI,
Admin_Password,
Admin_Realm,
Server_Host,
Server_Port,
Security,
Certificate,
Key,
Security_Mode,
Exchange_Certificate,
Hotplug_Port,
Max_Connection,
Send_Buffer_Size,
Free_Slots_Keep_Alive_Limit,
Keep_Alive_Force_Limit,
Keep_Alive_Close_Limit,
Accept_Queue_Size,
Log_File_Directory,
Log_Filename_Prefix,
Log_Extended_Fields,
Log_Split_Mode,
Log_Size_Limit,
Error_Log_Filename_Prefix,
Error_Log_Split_Mode,
Upload_Directory,
Upload_Size_Limit,
Session,
Session_Name,
Cleaner_Wait_For_Client_Timeout,
Cleaner_Client_Header_Timeout,
Cleaner_Client_Data_Timeout,
Cleaner_Server_Response_Timeout,
Force_Wait_For_Client_Timeout,
Force_Client_Header_Timeout,
Force_Client_Data_Timeout,
Force_Server_Response_Timeout,
Send_Timeout,
Receive_Timeout,
Status_Page,
Directory_Browser_Page,
Up_Image,
Down_Image,
Logo_Image,
Line_Stack_Size,
Reuse_Address,
Check_URL_Validity,
Case_Sensitive_Parameters,
MIME_Types,
-- Per process options
Session_Cleanup_Interval,
Session_Lifetime,
Transient_Cleanup_Interval,
Transient_Lifetime,
Input_Line_Size_Limit,
Max_Concurrent_Download,
Context_Lifetime);
subtype Server_Parameter_Name is Parameter_Name
range Server_Name .. MIME_Types;
subtype Process_Parameter_Name is Parameter_Name
range Session_Cleanup_Interval .. Context_Lifetime;
type Value_Type is (Str, Dir, Nat, Pos, Dur, Bool, Str_Vect);
type Values (Kind : Value_Type := Str) is record
case Kind is
when Str =>
Str_Value : Unbounded_String;
when Dir =>
Dir_Value : Unbounded_String;
when Pos =>
Pos_Value : Positive;
when Nat =>
Nat_Value : Natural;
when Dur =>
Dur_Value : Duration;
when Bool =>
Bool_Value : Boolean;
when Str_Vect =>
Strs_Value : SV.Vector;
end case;
end record;
type Parameter_Set is array (Parameter_Name range <>) of Values;
Default_Parameters : constant Parameter_Set (Server_Parameter_Name)
:= (Cleaner_Wait_For_Client_Timeout =>
(Dur, Default.Cleaner_Wait_For_Client_Timeout),
Cleaner_Client_Header_Timeout =>
(Dur, Default.Cleaner_Client_Header_Timeout),
Cleaner_Client_Data_Timeout =>
(Dur, Default.Cleaner_Client_Data_Timeout),
Cleaner_Server_Response_Timeout =>
(Dur, Default.Cleaner_Server_Response_Timeout),
Force_Wait_For_Client_Timeout =>
(Dur, Default.Force_Wait_For_Client_Timeout),
Force_Client_Header_Timeout =>
(Dur, Default.Force_Client_Header_Timeout),
Force_Client_Data_Timeout =>
(Dur, Default.Force_Client_Data_Timeout),
Force_Server_Response_Timeout =>
(Dur, Default.Force_Server_Response_Timeout),
Send_Timeout =>
(Dur, Default.Send_Timeout),
Receive_Timeout =>
(Dur, Default.Receive_Timeout),
Status_Page =>
(Str, To_Unbounded_String (Default.Status_Page)),
Directory_Browser_Page =>
(Str, To_Unbounded_String (Default.Directory_Browser_Page)),
Up_Image =>
(Str, To_Unbounded_String (Default.Up_Image)),
Down_Image =>
(Str, To_Unbounded_String (Default.Down_Image)),
Logo_Image =>
(Str, To_Unbounded_String (Default.Logo_Image)),
Admin_Password =>
(Str, To_Unbounded_String (Default.Admin_Password)),
Admin_Realm =>
(Str, To_Unbounded_String (Default.Admin_Realm)),
Admin_URI =>
(Str, To_Unbounded_String (Default.Admin_URI)),
Server_Name =>
(Str, To_Unbounded_String (Default.Server_Name)),
WWW_Root =>
(Dir, To_Unbounded_String (Default.WWW_Root)),
Log_File_Directory =>
(Dir, To_Unbounded_String (Default.Log_File_Directory)),
Log_Filename_Prefix =>
(Str, To_Unbounded_String (Default.Log_Filename_Prefix)),
Log_Extended_Fields =>
(Str_Vect, SV.Empty_Vector),
Log_Split_Mode =>
(Str, To_Unbounded_String (Default.Log_Split_Mode)),
Log_Size_Limit =>
(Nat, Default.Log_Size_Limit),
Error_Log_Filename_Prefix =>
(Str, To_Unbounded_String (Default.Error_Log_Filename_Prefix)),
Error_Log_Split_Mode =>
(Str, To_Unbounded_String (Default.Error_Log_Split_Mode)),
Upload_Directory =>
(Dir, To_Unbounded_String (Default.Upload_Directory)),
Upload_Size_Limit =>
(Pos, Default.Upload_Size_Limit),
Max_Connection =>
(Pos, Default.Max_Connection),
Send_Buffer_Size =>
(Nat, Default.Send_Buffer_Size),
Free_Slots_Keep_Alive_Limit =>
(Nat, Default.Free_Slots_Keep_Alive_Limit),
Keep_Alive_Force_Limit =>
(Nat, Default.Keep_Alive_Force_Limit),
Keep_Alive_Close_Limit =>
(Nat, Default.Keep_Alive_Close_Limit),
Accept_Queue_Size =>
(Pos, Default.Accept_Queue_Size),
Server_Host =>
(Str, Null_Unbounded_String),
Server_Port =>
(Nat, Default.Server_Port),
Hotplug_Port =>
(Pos, Default.Hotplug_Port),
Session =>
(Bool, Default.Session),
Session_Name =>
(Str, To_Unbounded_String (Default.Session_Name)),
Security =>
(Bool, Default.Security),
Certificate =>
(Str, To_Unbounded_String (Default.Certificate)),
Key =>
(Str, To_Unbounded_String (Default.Key)),
Security_Mode =>
(Str, To_Unbounded_String (Default.Security_Mode)),
Exchange_Certificate =>
(Bool, Default.Exchange_Certificate),
Case_Sensitive_Parameters =>
(Bool, Default.Case_Sensitive_Parameters),
Check_URL_Validity =>
(Bool, Default.Check_URL_Validity),
Line_Stack_Size =>
(Pos, Default.Line_Stack_Size),
Reuse_Address =>
(Bool, Default.Reuse_Address),
MIME_Types =>
(Str, To_Unbounded_String (Default.MIME_Types)));
type Object is record
P : Parameter_Set (Server_Parameter_Name) := Default_Parameters;
end record;
Default_Config : constant Object := (P => Default_Parameters);
Process_Options : Parameter_Set (Process_Parameter_Name)
:= (Session_Cleanup_Interval =>
(Dur, Default.Session_Cleanup_Interval),
Session_Lifetime =>
(Dur, Default.Session_Lifetime),
Transient_Cleanup_Interval =>
(Dur, Default.Transient_Cleanup_Interval),
Transient_Lifetime =>
(Dur, Default.Transient_Lifetime),
Input_Line_Size_Limit =>
(Pos, Default.Input_Line_Size_Limit),
Max_Concurrent_Download =>
(Pos, Default.Max_Concurrent_Download),
Context_Lifetime =>
(Dur, Default.Context_Lifetime));
end AWS.Config;
|