1docs::api::ModPerl::RegUissetrryCCoonotkreirb(u3t)ed PerdlocDso:c:uampein:t:aMtoidoPnerl::RegistryCooker(3)
2
6 ModPerl::RegistryCooker - Cook mod_perl 2.0 Registry Modules
7
9 # shouldn't be used as-is but sub-classed first
10 # see ModPerl::Registry for an example
11
13 "ModPerl::RegistryCooker" is used to create flexible and overridable
14 registry modules which emulate mod_cgi for Perl scripts. The concepts
15 are discussed in the manpage of the following modules:
16 "ModPerl::Registry", "ModPerl::Registry" and "ModPerl::RegistryBB".
17 "ModPerl::RegistryCooker" has two purposes:
19 • Provide ingredients that can be used by registry sub-classes
21 • Provide a default behavior, which can be overriden in sub-classed
23 META: in the future this functionality may move into a separate
25 class.
26 Here are the current overridable methods:
28 META: these are all documented in RegistryCooker.pm, though not using
30 pod. please help to port these to pod and move the descriptions here.
31 • new()
33 create the class's object, bless it and return it
35 my $obj = $class->new($r);
37 $class -- the registry class, usually "__PACKAGE__" can be used.
39 $r -- "Apache2::Request" object.
41 default: new()
43 • init()
45 initializes the data object's fields: "REQ", "FILENAME", "URI".
47 Called from the new().
48 default: init()
50 • default_handler()
52 default: default_handler()
54 • run()
56 default: run()
58 • can_compile()
60 default: can_compile()
62 • make_namespace()
64 default: make_namespace()
66 • namespace_root()
68 default: namespace_root()
70 • namespace_from()
72 If "namespace_from_uri" is used and the script is called from the
74 virtual host, by default the virtual host name is prepended to the
75 uri when package name for the compiled script is created. Sometimes
76 this behavior is undesirable, e.g., when the same (physical) script
77 is accessed using the same path_info but different virtual hosts.
78 In that case you can make the script compiled only once for all
79 vhosts, by specifying:
80 $ModPerl::RegistryCooker::NameWithVirtualHost = 0;
82 The drawback is that it affects the global environment and all
84 other scripts will be compiled ignoring virtual hosts.
85 default: namespace_from()
87 • is_cached()
89 default: is_cached()
91 • should_compile()
93 default: should_compile()
95 • flush_namespace()
97 default: flush_namespace()
99 • cache_table()
101 default: cache_table()
103 • cache_it()
105 default: cache_it()
107 • read_script()
109 default: read_script()
111 • shebang_to_perl()
113 default: shebang_to_perl()
115 • get_script_name()
117 default: get_script_name()
119 • chdir_file()
121 default: chdir_file()
123 • get_mark_line()
125 default: get_mark_line()
127 • compile()
129 default: compile()
131 • error_check()
133 default: error_check()
135 • strip_end_data_segment()
137 default: strip_end_data_segment()
139 • convert_script_to_compiled_handler()
141 default: convert_script_to_compiled_handler()
143 Special Predefined Functions
145 The following functions are implemented as constants.
146 • NOP()
148 Use when the function shouldn't do anything.
150 • TRUE()
152 Use when a function should always return a true value.
154 • FALSE()
156 Use when a function should always return a false value.
158
160 To override the default "ModPerl::RegistryCooker" methods, first, sub-
161 class "ModPerl::RegistryCooker" or one of its existing sub-classes,
162 using "use base". Second, override the methods.
163 Those methods that weren't overridden will be resolved at run time when
165 used for the first time and cached for the future requests. One way to
166 to shortcut this first run resolution is to use the symbol aliasing
167 feature. For example to alias "ModPerl::MyRegistry::flush_namespace" as
168 "ModPerl::RegistryCooker::flush_namespace", you can do:
169 package ModPerl::MyRegistry;
171 use base qw(ModPerl::RegistryCooker);
172 *ModPerl::MyRegistry::flush_namespace =
173 \&ModPerl::RegistryCooker::flush_namespace;
174 1;
175 In fact, it's a good idea to explicitly alias all the methods so you
177 know exactly what functions are used, rather then relying on the
178 defaults. For that purpose "ModPerl::RegistryCooker" class method
179 install_aliases() can be used. Simply prepare a hash with method names
180 in the current package as keys and corresponding fully qualified
181 methods to be aliased for as values and pass it to install_aliases().
182 Continuing our example we could do:
183 package ModPerl::MyRegistry;
185 use base qw(ModPerl::RegistryCooker);
186 my %aliases = (
187 flush_namespace => 'ModPerl::RegistryCooker::flush_namespace',
188 );
189 __PACKAGE__->install_aliases(\%aliases);
190 1;
191 The values use fully qualified packages so you can mix methods from
193 different classes.
194
196 The best examples are existing core registry modules:
197 "ModPerl::Registry", "ModPerl::Registry" and "ModPerl::RegistryBB".
198 Look at the source code and their manpages to see how they subclass
199 "ModPerl::RegistryCooker".
200 For example by default "ModPerl::Registry" uses the script's path when
202 creating a package's namespace. If for example you want to use a uri
203 instead you can override it with:
204 *ModPerl::MyRegistry::namespace_from =
206 \&ModPerl::RegistryCooker::namespace_from_uri;
207 1;
208 Since the "namespace_from_uri" component already exists in
210 "ModPerl::RegistryCooker". If you want to write your own method, e.g.,
211 that creates a namespace based on the inode, you can do:
212 sub namespace_from_inode {
214 my $self = shift;
215 return (stat $self->[FILENAME])[1];
216 }
217 META: when $r->finfo will be ported it'll be more effecient. (stat
219 $r->finfo)[1]
220
222 Doug MacEachern
223 Stas Bekman
225
227 "ModPerl::Registry", "ModPerl::RegistryBB" and "ModPerl::PerlRun".
228perl v5.38.0 2023-07-d2o0cs::api::ModPerl::RegistryCooker(3)