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
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
|
/*###################################################################################
#
# Embperl - Copyright (c) 1997-2008 Gerald Richter / ecos gmbh www.ecos.de
# Embperl - Copyright (c) 2008-2014 Gerald Richter
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
#
# THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
# IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
# WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
#
# $Id: epcache.c 1578075 2014-03-16 14:01:14Z richter $
#
###################################################################################*/
#include "ep.h"
#include "epmacro.h"
/* --- don't use Perl's memory management here --- */
#ifndef DMALLOC
#undef malloc
#undef realloc
#undef strdup
#undef free
#endif
HV * pProviders ; /**< global hash that holds all known providers classes */
HV * pCacheItems ; /**< hash which contains all CacheItems by Key */
tCacheItem * * pCachesToRelease = NULL ;
/* ------------------------------------------------------------------------ */
/* */
/* Cache_AddProviderClass */
/* */
/*!
* \_en
* Add a provider class to list of known providers
* @param sName Name of the Providerclass
* @param pProviderClass Provider class record
* @return error code
*
* \endif
*
* \_de
* Fgt eine Providerklasse den der Liste der bekannten Providern hinzu
* @param sName Name der Providerklasse
* @param pProviderClass Provider class record
* @return Fehlercode
*
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_AddProviderClass (/*in*/ const char * sName,
/*in*/ tProviderClass * pClass)
{
SetHashValueInt (NULL, pProviders, sName, (IV)pClass) ;
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_Init */
/* */
/*!
* \_en
* Do global initialization of cache system
* @return error code
*
* \endif
*
* \_de
* Fhrt die globale Initialisierung des Cachesystems durch
* @return Fehlercode
*
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_Init (/*in*/ tApp * a)
{
epaTHX_
pProviders = newHV () ;
pCacheItems = newHV () ;
ArrayNew (a, &pCachesToRelease, 16, sizeof (tCacheItem *)) ;
/* lprintf (a, "XXXXX Cache_Init [%d/%d] pProviders=%x pCacheItems=%x pCachesToRelease=%x", _getpid(), GetCurrentThreadId(), pProviders, pCacheItems, pCachesToRelease) ; */
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_CleanupRequest */
/* */
/*!
* \_en
* Do cleanup at end of request
* @param r Embperl request record
* @return error code
*
* \endif
*
* \_de
* Fhrt die Aufrumarbeiten am Requestende aus
* @param r Embperl request record
* @return Fehlercode
*
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_CleanupRequest (req * r)
{
if (pCachesToRelease)
{
int n = ArrayGetSize (r -> pApp, pCachesToRelease) ;
int i ;
/* lprintf (r -> pApp, "XXXXX Cache_CleanupRequest [%d/%d] pProviders=%x pCacheItems=%x pCachesToRelease=%x", _getpid(), GetCurrentThreadId(), pProviders, pCacheItems, pCachesToRelease) ; */
for (i = 0; i < n; i++)
Cache_FreeContent (r, pCachesToRelease[i]) ;
ArraySetSize(r -> pApp, &pCachesToRelease, 0) ;
}
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_ParamUpdate */
/* */
int Cache_ParamUpdate (/*in*/ req * r,
/*in*/ HV * pProviderParam,
/*in*/ bool bTopLevel,
/*in*/ char * sLogText,
/*in*/ tCacheItem * pNew)
{
epTHX_
char * exfn ;
int rc ;
pNew -> nExpiresInTime = GetHashValueInt (aTHX_ pProviderParam, "expires_in", bTopLevel?r -> Component.Config.nExpiresIn:0) ;
if (pNew -> pExpiresCV)
SvREFCNT_dec (pNew -> pExpiresCV) ;
if ((rc = GetHashValueCREF (r, pProviderParam, "expires_func", &pNew -> pExpiresCV)) != ok)
return rc ;
if (!pNew -> pExpiresCV && bTopLevel)
pNew -> pExpiresCV = (CV *)SvREFCNT_inc((SV *)r -> Component.Config.pExpiredFunc) ;
exfn = GetHashValueStrDupA (aTHX_ pProviderParam, "expires_filename", bTopLevel?r -> Component.Config.sExpiresFilename:NULL) ;
if (pNew -> sExpiresFilename)
{
if (exfn)
{
/* lprintf (r -> pApp, "exfn=%s\n", exfn) ; */
free ((void *)pNew -> sExpiresFilename) ;
pNew -> sExpiresFilename = exfn ;
}
}
else
pNew -> sExpiresFilename = exfn ;
pNew -> bCache = (bool)GetHashValueInt (aTHX_ pProviderParam, "cache", exfn || pNew -> pExpiresCV || pNew -> nExpiresInTime?1:0) ;
if (sLogText && (r -> Component.Config.bDebug & dbgCache))
lprintf (r -> pApp, "[%d]CACHE: %s CacheItem %s; expires_in=%d expires_func=%s expires_filename=%s cache=%s\n",
r -> pThread -> nPid, sLogText, pNew -> sKey, pNew -> nExpiresInTime,
pNew -> pExpiresCV?"yes":"no", pNew -> sExpiresFilename?pNew -> sExpiresFilename:"",
pNew -> bCache?"yes":"no") ;
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_New */
/* */
/*!
* \_en
* Checks if a CacheItem which matches the parameters already exists, if
* not it creates a new CacheItem and fills it with data from the hash
* pParam
*
* @param r Embperl request record
* @param pParam Parameter (PV,HV,AV)
* expires_in number of seconds when the item
* expires, 0 = expires never
* expires_func Perl Function (coderef) that
* is called and item is expired
* if it returns TRUE
* expires_filename item expires when modification
* time of file changes
* cache set to zero to not cache the content
* provider parameter for the provider
* @param nParamNdx If pParam is a AV, this parameter gives the index into the Array
* @param bTopLevel True if last elemet before output. In this case the cache parameters
* defaults to the ones from Componet.Config
* @param pItem Return of the new Items
* @return error code
* \endif
*
* \_de
* Prft ob ein passendes CacheItem bereits vorhanden ist, wenn nicht
* erzeugt die Funktion ein neues CacheItem und fllte es mit den Daten aus
* pParam
*
* @param r Embperl request record
* @param pParam Parameter (PV,HV,AV)
* expires_in anzahl der Sekunden wenn Item
* abluft; 0 = nie
* expires_func Perl Funktion (coderef) die
* aufgerufen wird. Wenn sie wahr
* zurckgibt ist das Item abgelaufen
* expires_filename Item ist abgelaufen wenn
* Dateidatum sich ndert
* cache Auf Null setzen damit Inhalt
* nicht gecacht wird
* provider parameter fr Provider
* @param nParamNdx Wenn pParam ein AV ist, gibt dieser Parameter den Index an
* @param bTopLevel Wahr wenn letztes Element vor der Ausgabe, dann werden
* die Cache Parameter aus Componet.Config herangezogen
* @param pItem Rckgabe des neuen Items
* @return Fehlercode
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_New (/*in*/ req * r,
/*in*/ SV * pParam,
/*in*/ IV nParamNdx,
/*in*/ bool bTopLevel,
/*in*/ tCacheItem * * pItem)
{
epTHX_
int rc ;
HV * pProviderParam ;
char * sProvider ;
tProviderClass * pProviderClass ;
tCacheItem * pNew = NULL ;
SV * pKey = NULL ;
const char * sKey = "" ;
STRLEN len ;
/* lprintf (r -> pApp, "XXXXX Cache_New [%d/%d] pProviders=%x %s pCacheItems=%x %s pCachesToRelease=%x %s\n", _getpid(), GetCurrentThreadId(), pProviders, IsBadReadPtr (pProviders,4 )?"bad":"ok", pCacheItems, IsBadReadPtr (pCacheItems, 4)?"bad":"ok", pCachesToRelease, IsBadReadPtr (pCachesToRelease, 4)?"bad":"ok") ; */
if (SvROK(pParam))
pParam = SvRV (pParam) ;
if (SvTYPE(pParam) == SVt_PV)
{
/* change this to auto match later on ... */
pProviderParam = (HV *)SvRV(sv_2mortal (CreateHashRef (r,
"type", hashtstr, "file",
"filename", hashtsv, pParam,
NULL)
)) ;
}
else if (SvTYPE(pParam) == SVt_PVAV)
{
SV * * ppRV = av_fetch ((AV *)pParam, nParamNdx, 0) ;
if (!ppRV || !*ppRV)
{
strncpy (r -> errdat1, "<provider missing>", sizeof(r -> errdat1) - 1) ;
return rcUnknownProvider ;
}
if (!SvROK (*ppRV) || SvTYPE(pProviderParam = (HV *)SvRV (*ppRV)) != SVt_PVHV)
{
strncpy (r -> errdat1, "<provider missing, element is no hashref>", sizeof(r -> errdat1) - 1) ;
return rcUnknownProvider ;
}
}
else if (SvTYPE(pParam) == SVt_PVHV)
{
pProviderParam = (HV *)pParam ;
}
else
{
strncpy (r -> errdat1, "<provider missing, no description found>", sizeof(r -> errdat1) - 1) ;
return rcUnknownProvider ;
}
sProvider = GetHashValueStr (aTHX_ pProviderParam, "type", "") ;
pProviderClass = (tProviderClass *)GetHashValuePtr (r, pProviders, sProvider, NULL) ;
if (!pProviderClass)
{
if (*sProvider)
strncpy (r -> errdat1, sProvider, sizeof(r -> errdat1) - 1) ;
else
strncpy (r -> errdat1, "<provider missing>", sizeof(r -> errdat1) - 1) ;
return rcUnknownProvider ;
}
pKey = newSVpv ("", 0) ;
if (pProviderClass -> fAppendKey)
if ((rc = (*pProviderClass -> fAppendKey)(r, pProviderClass, pProviderParam, pParam, nParamNdx - 1, pKey)) != ok)
return rc ;
sKey = SvPV(pKey, len) ;
if ((pNew = Cache_GetByKey (r, sKey)))
{
Cache_ParamUpdate (r, pProviderParam, bTopLevel, "Update", pNew) ;
if (pProviderClass -> fUpdateParam)
if ((rc = (*pProviderClass -> fUpdateParam)(r, pNew -> pProvider, pProviderParam)) != ok)
return rc ;
}
if (!pNew)
{
pNew = cache_malloc (r, sizeof(tCacheItem)) ;
if (!pNew)
{
if (pKey)
SvREFCNT_dec (pKey) ;
return rcOutOfMemory ;
}
*pItem = NULL ;
memset (pNew, 0, sizeof (tCacheItem)) ;
Cache_ParamUpdate (r, pProviderParam, bTopLevel, NULL, pNew) ;
pNew -> sKey = strdup (sKey) ;
if (pProviderParam)
{
if ((rc = (*pProviderClass -> fNew)(r, pNew, pProviderClass, pProviderParam, pParam, nParamNdx - 1)) != ok)
{
if (pKey)
SvREFCNT_dec (pKey) ;
cache_free (r, pNew) ;
return rc ;
}
if (pProviderClass -> fUpdateParam)
if ((rc = (*pProviderClass -> fUpdateParam)(r, pNew -> pProvider, pProviderParam)) != ok)
return rc ;
}
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: Created new CacheItem %s; expires_in=%d expires_func=%s expires_filename=%s cache=%s\n",
r -> pThread -> nPid, sKey, pNew -> nExpiresInTime,
pNew -> pExpiresCV?"yes":"no", pNew -> sExpiresFilename?pNew -> sExpiresFilename:"",
pNew -> bCache?"yes":"no") ;
SetHashValueInt (r, pCacheItems, sKey, (IV)pNew) ;
}
if (pKey)
SvREFCNT_dec (pKey) ;
*pItem = pNew ;
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_AppendKey */
/* */
/*!
* \_en
* Append it's key to the keystring. If it depends on anything it must
* call Cache_AppendKey for any dependency.
* The file provider appends the filename
*
* @param r Embperl request record
* @param pParam Parameter Hash
* @param sSubProvider sub provider parameter
* @param pKey Key to which string should be appended
* @return error code
* \endif
*
* \_de
* Hngt ein eigenen Schlssel an den Schlsselstring an. Wenn irgednwelche
* Abhnigkeiten bestehen, mu Cache_AppendKey fr alle Abhnigkeiten aufgerufen
* werden.
* Der File Provider hngt den Dateinamen an.
*
* @param r Embperl request record
* @param pParam Parameter Hash
* @param sSubProvider sub provider parameter
* @param pKey Schlssel zu welchem hinzugefgt wird
* @return Fehlercode
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_AppendKey (/*in*/ req * r,
/*in*/ HV * pProviderParam,
/*in*/ const char * sSubProvider,
/*in*/ SV * pParam,
/*in*/ IV nParamIndex,
/*i/o*/ SV * pKey)
{
epTHX_
int rc ;
char * sProvider ;
tProviderClass * pProviderClass ;
STRLEN len ;
tCacheItem * pItem ;
SV * pSubParam = GetHashValueSV (r, pProviderParam, sSubProvider) ;
if (pSubParam)
pParam = pSubParam ;
if (!pParam)
{
strncpy (r -> errdat1, sSubProvider, sizeof (r -> errdat1) - 1) ;
return rcMissingParam ;
}
if (SvROK(pParam))
pParam = SvRV (pParam) ;
if (SvTYPE(pParam) == SVt_PV)
{
/* change this to auto match later on ... */
pProviderParam = (HV *)SvRV(sv_2mortal (CreateHashRef (r,
"type", hashtstr, "file",
"filename", hashtsv, pParam,
NULL)
)) ;
}
else if (SvTYPE(pParam) == SVt_PVAV)
{
SV * * ppRV = av_fetch ((AV *)pParam, nParamIndex, 0) ;
if (!ppRV || !*ppRV)
{
strncpy (r -> errdat1, "<provider missing>", sizeof(r -> errdat1) - 1) ;
return rcUnknownProvider ;
}
if (!SvROK (*ppRV) || SvTYPE(pProviderParam = (HV *)SvRV (*ppRV)) != SVt_PVHV)
{
strncpy (r -> errdat1, "<provider missing, element is no hashref>", sizeof(r -> errdat1) - 1) ;
return rcUnknownProvider ;
}
}
else if (SvTYPE(pParam) == SVt_PVHV)
{
pProviderParam = (HV *)pParam ;
}
else
{
strncpy (r -> errdat1, "<provider missing, no description found>", sizeof(r -> errdat1) - 1) ;
return rcUnknownProvider ;
}
sProvider = GetHashValueStr (aTHX_ pProviderParam, "type", "") ;
pProviderClass = (tProviderClass *)GetHashValuePtr (r, pProviders, sProvider, NULL) ;
if (!pProviderClass)
{
if (*sProvider)
strncpy (r -> errdat1, sProvider, sizeof(r -> errdat1) - 1) ;
else
strncpy (r -> errdat1, "<provider missing>", sizeof(r -> errdat1) - 1) ;
return rcUnknownProvider ;
}
if (pProviderClass -> fAppendKey)
if ((rc = (*pProviderClass -> fAppendKey)(r, pProviderClass, pProviderParam, pParam, nParamIndex - 1, pKey)) != ok)
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: Error in Update CacheItem provider=%s\n",
r -> pThread -> nPid, sProvider) ;
return rc ;
}
if ((pItem = Cache_GetByKey (r, SvPV(pKey, len))))
{
int bCache = pItem -> bCache ;
Cache_ParamUpdate (r, pProviderParam, 0, "Update", pItem) ;
if (!pItem -> bCache && bCache)
Cache_FreeContent (r, pItem) ;
if (pProviderClass -> fUpdateParam)
if ((rc = (*pProviderClass -> fUpdateParam)(r, pItem -> pProvider, pProviderParam)) != ok)
return rc ;
}
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_GetByKey */
/* */
/*!
* \_en
* Gets an CacheItem by it's key.
*
* @param r Embperl request record
* @param sKey Key
* @return Returns the cache item specified by the key if found
* \endif
*
* \_de
* Liefert das durch den Schlssel angegeben CacheItem zurck.
*
* @param r Embperl request record
* @param sKey Key
* @return Liefert das CacheItem welches durch den Schlssel
* angegeben wird, soweit gefunden.
* \endif
*
* ------------------------------------------------------------------------ */
tCacheItem * Cache_GetByKey (/*in*/ req * r,
/*in*/ const char * sKey)
{
tCacheItem * pItem ;
pItem = (tCacheItem *)GetHashValuePtr (r, pCacheItems, sKey, NULL) ;
return pItem ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_AddDependency */
/* */
/*!
* \_en
* Adds a CacheItem on which this cache items depends
*
* @param r Embperl request record
* @param pItem CacheItem which depends on pDependsOn
* @param pDependsOn CacheItem on which pItem depends
* @return 0 on success
* \endif
*
* \_de
* Fgt ein CacheItem von welches Adds a CacheItem on which this cache items depends
*
* @param r Embperl request record
* @param pItem CacheItem welches von pDependsOn anhngt
* @param pDependsOn CacheItem von welchem pItem abhngt
* @return 0 wenn fehlerfrei ausgefhrt
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_AddDependency (/*in*/ req * r,
/*in*/ tCacheItem * pItem,
/*in*/ tCacheItem * pDependsOn)
{
int n ;
if (!pItem -> pDependsOn)
ArrayNew (r -> pApp, &pItem -> pDependsOn, 2, sizeof (tCacheItem *)) ;
n = ArrayAdd (r -> pApp, &pItem -> pDependsOn, 1) ;
pItem -> pDependsOn[n] = pDependsOn ;
if (!pDependsOn -> pNeededFor)
ArrayNew (r -> pApp, &pDependsOn -> pNeededFor, 2, sizeof (tCacheItem *)) ;
n = ArrayAdd (r -> pApp, &pDependsOn -> pNeededFor, 1) ;
pDependsOn -> pNeededFor[n] = pItem ;
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_GetDependency */
/* */
/*!
* \_en
* Get the Nth CacheItem on which this cache depends
*
* @param r Embperl request record
* @param pItem CacheItem
* @param n Dependency number
* @return Nth Dependency CacheItem
* \endif
*
* \_de
* Gibt das Nte CacheItem von dem pItem abhngt zurck
*
* @param r Embperl request record
* @param pItem CacheItem
* @param n Number der Abhnigkeit
* @return Ntes CacheItem von welchem pItem abhngt
* \endif
*
* ------------------------------------------------------------------------ */
tCacheItem * Cache_GetDependency (/*in*/ req * r,
/*in*/ tCacheItem * pItem,
/*in*/ int n)
{
if (!pItem -> pDependsOn || ArrayGetSize (r -> pApp, pItem -> pDependsOn) < n || n < 0)
return NULL ;
return pItem -> pDependsOn[n] ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_IsExpired */
/* */
/*!
* \_en
* Checks if the cache item or a cache item on which this one depends is
* expired
*
* @param r Embperl request record
* @param pItem CacheItem which should be checked
* @param nLastUpdated When a item on which this one depends, was
* updated after the given request count, then
* this item is expired
* @return TRUE if expired, otherwise FALSE
* \endif
*
* \_de
* Prft ob das CacheItem oder eines von welchem dieses abhngt nihct
* mehr gltig ist
*
* @param r Embperl request record
* @param pItem CacheItem welches berprft werden soll
* @param nLastUpdated Wenn ein Item von welchem dieses Item abhngt
* nach dem angegebenen Request Count gendert
* wurde ist diese Item nicht mehr gltig
* @return wahr wenn ungltig, ansonsten falsch
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_IsExpired (/*in*/ req * r,
/*in*/ tCacheItem * pItem,
/*in*/ int nLastUpdated)
{
epTHX_
int rc ;
tCacheItem * pSubItem ;
int i ;
int numItems = pItem -> pDependsOn?ArrayGetSize (r -> pApp, pItem -> pDependsOn):0 ;
if (nLastUpdated < pItem -> nLastUpdated)
return TRUE ;
if (pItem -> pProvider -> pProviderClass -> fExpires)
{
if ((*pItem -> pProvider -> pProviderClass -> fExpires)(r, pItem -> pProvider))
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s expired because provider C sub returned TRUE\n", r -> pThread -> nPid, pItem -> sKey) ;
Cache_FreeContent (r, pItem) ;
return pItem -> bExpired = TRUE ;
}
}
if (pItem -> bExpired || pItem -> nLastChecked == r -> nRequestCount)
return pItem -> bExpired ; /* we already have checked this or know that is it expired */
pItem -> nLastChecked = r -> nRequestCount ;
/* first check dependency */
for (i = 0; i < numItems; i++)
{
pSubItem = pItem -> pDependsOn[i] ;
if (Cache_IsExpired (r, pSubItem, pItem -> nLastUpdated))
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s expired because dependencies is expired or newer\n", r -> pThread -> nPid, pItem -> sKey) ;
Cache_FreeContent (r, pItem) ;
return pItem -> bExpired = TRUE ;
}
}
if (pItem -> nExpiresInTime && pItem -> nLastModified + pItem -> nExpiresInTime < r -> nRequestTime)
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s expired because of timeout (%d sec)\n", r -> pThread -> nPid, pItem -> sKey, pItem -> nExpiresInTime) ;
Cache_FreeContent (r, pItem) ;
return pItem -> bExpired = TRUE ;
}
if (pItem -> sExpiresFilename)
{
#ifdef WIN32
if (_stat (pItem -> sExpiresFilename, &pItem -> FileStat))
#else
if (stat (pItem -> sExpiresFilename, &pItem -> FileStat))
#endif
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s expired because cannot stat file %s\n", r -> pThread -> nPid, pItem -> sKey, pItem -> sExpiresFilename) ;
Cache_FreeContent (r, pItem) ;
return pItem -> bExpired = TRUE ;
}
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s stat file %s mtime=%d size=%d\n", r -> pThread -> nPid, pItem -> sKey, pItem -> sExpiresFilename, pItem -> FileStat.st_mtime, pItem -> FileStat.st_size) ;
if (pItem -> nFileModified != pItem -> FileStat.st_mtime)
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s expired because file %s changed\n", r -> pThread -> nPid, pItem -> sKey, pItem -> sExpiresFilename) ;
pItem -> nFileModified = pItem -> FileStat.st_mtime ;
Cache_FreeContent (r, pItem) ;
return pItem -> bExpired = TRUE ;
}
}
if (pItem -> pExpiresCV)
{
SV * pRet ;
if ((rc = CallCV (r, "Expired?", pItem -> pExpiresCV, 0, &pRet)) != ok)
{
LogError (r, rc) ;
Cache_FreeContent (r, pItem) ;
return pItem -> bExpired = TRUE ;
}
if (pRet && SvTRUE(pRet))
{ /* Expire the entry */
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s expired because expirey Perl sub returned TRUE\n", r -> pThread -> nPid, pItem -> sKey) ;
Cache_FreeContent (r, pItem) ;
return pItem -> bExpired = TRUE ;
}
}
if (pItem -> fExpires)
{
if ((*pItem -> fExpires)(pItem))
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s expired because expirey C sub returned TRUE\n", r -> pThread -> nPid, pItem -> sKey) ;
Cache_FreeContent (r, pItem) ;
return pItem -> bExpired = TRUE ;
}
}
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s NOT expired\n", r -> pThread -> nPid, pItem -> sKey) ;
return FALSE ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_SetNotExpired */
/* */
/*!
* \_en
* Reset expired flag and last modification time
*
* @param r Embperl request record
* @param pItem CacheItem which should be checked
* @return TRUE if expired, otherwise FALSE
* \endif
*
* \_de
* Abgelaufen Flag zurcksetzen und Zeitpunkt der letzten nderung setzen
*
* @param r Embperl request record
* @param pItem CacheItem welches berprft werden soll
* @return wahr wenn ungltig, ansonsten falsch
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_SetNotExpired (/*in*/ req * r,
/*in*/ tCacheItem * pItem)
{
pItem -> nLastChecked = r -> nRequestCount ;
pItem -> nLastUpdated = r -> nRequestCount ;
pItem -> nLastModified = r -> nRequestTime ;
pItem -> bExpired = FALSE ;
if (!pItem -> bCache)
{
int n = ArrayAdd(r -> pApp, &pCachesToRelease, 1) ;
pCachesToRelease[n] = pItem ;
}
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_GetContentSV */
/* */
/*!
* \_en
* Get the whole content as SV, if not expired from the cache, otherwise ask
* the provider to fetch it. This will also put a read lock on the
* Cacheitem. When you are done with the content call ReleaseContent
*
* @param r Embperl request record
* @param pItem CacheItem which should be checked
* @param pData Returns the content
* @param bUseCache Set if the content should not recomputed
* @return error code
* \endif
*
* \_de
* Holt den gesamt Inhalt als SV soweit nich abgelaufen aus dem Cache, ansonsten
* wird der Provider beauftragt ihn einzulesen. Zustzlich wird ein
* Read Lock gesetzt. Nach der Bearbeitetung des Inhalts sollte deshalb
* ReleaseLock zum freigeben aufgerufen werden.
*
* @param r Embperl request record
* @param pItem CacheItem welches berprft werden soll
* @param pData Liefert den Inhalt
* @param bUseCache Gesetzt wenn der Inhalt nicht neu berechnet werden soll
* @return Fehlercode
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_GetContentSV (/*in*/ req * r,
/*in*/ tCacheItem *pItem,
/*in*/ SV * * pData,
/*in*/ bool bUseCache)
{
epTHX_
int rc ;
if (!bUseCache && (Cache_IsExpired (r, pItem, pItem -> nLastUpdated) || !pItem -> pSVData))
{
if (pItem -> pProvider -> pProviderClass -> fGetContentSV)
if ((rc = ((*pItem -> pProvider -> pProviderClass -> fGetContentSV) (r, pItem -> pProvider, pData, FALSE))) != ok)
{
Cache_FreeContent (r, pItem) ;
return rc ;
}
Cache_SetNotExpired (r, pItem) ;
if (pItem -> pSVData)
SvREFCNT_dec (pItem -> pSVData) ;
pItem -> pSVData = *pData ;
}
else
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s take from cache\n", r -> pThread -> nPid, pItem -> sKey) ;
*pData = pItem -> pSVData ;
if (pItem -> pProvider -> pProviderClass -> fGetContentSV)
if ((rc = ((*pItem -> pProvider -> pProviderClass -> fGetContentSV) (r, pItem -> pProvider, pData, TRUE))) != ok)
{
Cache_FreeContent (r, pItem) ;
return rc ;
}
}
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_GetContentPtr */
/* */
/*!
* \_en
* Get the whole content as pointer, if not expired from the cache, otherwise ask
* the provider to fetch it. This will also put a read lock on the
* Cacheitem. When you are done with the content call ReleaseContent
*
* @param r Embperl request record
* @param pItem CacheItem which should be checked
* @param pData Returns the content
* @param bUseCache Set if the content should not recomputed
* @return error code
* \endif
*
* \_de
* Holt den gesamt Inhalt als Zeiger soweit nich abgelaufen aus dem Cache, ansonsten
* wird der Provider beauftragt ihn einzulesen. Zustzlich wird ein
* Read Lock gesetzt. Nach der Bearbeitetung des Inhalts sollte deshalb
* ReleaseLock zum freigeben aufgerufen werden.
*
* @param r Embperl request record
* @param pItem CacheItem welches berprft werden soll
* @param pData Liefert den Inhalt
* @param bUseCache Gesetzt wenn der Inhalt nicht neu berechnet werden soll
* @return Fehlercode
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_GetContentPtr (/*in*/ req * r,
/*in*/ tCacheItem *pItem,
/*in*/ void * * pData,
/*in*/ bool bUseCache)
{
int rc ;
if (!bUseCache && (Cache_IsExpired (r, pItem, pItem -> nLastUpdated) || !pItem -> pData))
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s get from provider\n", r -> pThread -> nPid, pItem -> sKey) ;
if (pItem -> pProvider -> pProviderClass -> fGetContentPtr)
if ((rc = (*pItem -> pProvider -> pProviderClass -> fGetContentPtr) (r, pItem -> pProvider, pData, FALSE)) != ok)
{
Cache_FreeContent (r, pItem) ;
return rc ;
}
pItem -> pData = *pData ;
Cache_SetNotExpired (r, pItem) ;
}
else
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s take from cache\n", r -> pThread -> nPid, pItem -> sKey) ;
*pData = pItem -> pData ;
if (pItem -> pProvider -> pProviderClass -> fGetContentPtr)
if ((rc = (*pItem -> pProvider -> pProviderClass -> fGetContentPtr) (r, pItem -> pProvider, pData, TRUE)) != ok)
{
Cache_FreeContent (r, pItem) ;
return rc ;
}
}
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_GetContentIndex */
/* */
/*!
* \_en
* Get the whole content as pointer, if not expired from the cache, otherwise ask
* the provider to fetch it. This will also put a read lock on the
* Cacheitem. When you are done with the content call ReleaseContent
*
* @param r Embperl request record
* @param pItem CacheItem which should be checked
* @param pData Returns the content
* @param bUseCache Set if the content should not recomputed
* @return error code
* \endif
*
* \_de
* Holt den gesamt Inhalt als Zeiger soweit nich abgelaufen aus dem Cache, ansonsten
* wird der Provider beauftragt ihn einzulesen. Zustzlich wird ein
* Read Lock gesetzt. Nach der Bearbeitetung des Inhalts sollte deshalb
* ReleaseLock zum freigeben aufgerufen werden.
*
* @param r Embperl request record
* @param pItem CacheItem welches berprft werden soll
* @param pData Liefert den Inhalt
* @param bUseCache Gesetzt wenn der Inhalt nicht neu berechnet werden soll
* @return Fehlercode
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_GetContentIndex (/*in*/ req * r,
/*in*/ tCacheItem *pItem,
/*in*/ tIndex * pData,
/*in*/ bool bUseCache)
{
int rc ;
if (!bUseCache && (Cache_IsExpired (r, pItem, pItem -> nLastUpdated) || !pItem -> xData))
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s get from provider\n", r -> pThread -> nPid, pItem -> sKey) ;
if (pItem -> pProvider -> pProviderClass -> fGetContentIndex)
if ((rc = (*pItem -> pProvider -> pProviderClass -> fGetContentIndex) (r, pItem -> pProvider, pData, FALSE)) != ok)
{
Cache_FreeContent (r, pItem) ;
return rc ;
}
pItem -> xData = *pData ;
Cache_SetNotExpired (r, pItem) ;
}
else
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s take from cache\n", r -> pThread -> nPid, pItem -> sKey) ;
*pData = pItem -> xData ;
if (pItem -> pProvider -> pProviderClass -> fGetContentIndex)
if ((rc = (*pItem -> pProvider -> pProviderClass -> fGetContentIndex) (r, pItem -> pProvider, pData, TRUE)) != ok)
{
Cache_FreeContent (r, pItem) ;
return rc ;
}
}
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_GetContentSvIndex */
/* */
/*!
* \_en
* Get the whole content as pointer, if not expired from the cache, otherwise ask
* the provider to fetch it. This will also put a read lock on the
* Cacheitem. When you are done with the content call ReleaseContent
*
* @param r Embperl request record
* @param pItem CacheItem which should be checked
* @param pData Returns the content
* @param bUseCache Set if the content should not recomputed
* @return error code
* \endif
*
* \_de
* Holt den gesamt Inhalt als Zeiger soweit nich abgelaufen aus dem Cache, ansonsten
* wird der Provider beauftragt ihn einzulesen. Zustzlich wird ein
* Read Lock gesetzt. Nach der Bearbeitetung des Inhalts sollte deshalb
* ReleaseLock zum freigeben aufgerufen werden.
*
* @param r Embperl request record
* @param pItem CacheItem welches berprft werden soll
* @param pData Liefert den Inhalt
* @param bUseCache Gesetzt wenn der Inhalt nicht neu berechnet werden soll
* @return Fehlercode
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_GetContentSvIndex (/*in*/ req * r,
/*in*/ tCacheItem *pItem,
/*in*/ SV * * pSVData,
/*in*/ tIndex * pData,
/*in*/ bool bUseCache)
{
int rc ;
bool bUpdate = FALSE ;
if (!bUseCache && (Cache_IsExpired (r, pItem, pItem -> nLastUpdated)))
{
pItem -> xData = 0 ;
pItem -> pSVData = NULL ;
}
if (!pItem -> xData)
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s get from provider\n", r -> pThread -> nPid, pItem -> sKey) ;
if (pItem -> pProvider -> pProviderClass -> fGetContentIndex)
if ((rc = (*pItem -> pProvider -> pProviderClass -> fGetContentIndex) (r, pItem -> pProvider, pData, FALSE)) != ok)
{
Cache_FreeContent (r, pItem) ;
return rc ;
}
pItem -> xData = *pData ;
bUpdate = TRUE ;
}
else
{
*pData = pItem -> xData ;
if (pItem -> pProvider -> pProviderClass -> fGetContentIndex)
if ((rc = (*pItem -> pProvider -> pProviderClass -> fGetContentIndex) (r, pItem -> pProvider, pData, TRUE)) != ok)
{
Cache_FreeContent (r, pItem) ;
return rc ;
}
}
if (!pItem -> pSVData)
{
if ((r -> Component.Config.bDebug & dbgCache) && !bUpdate)
lprintf (r -> pApp, "[%d]CACHE: %s get from provider\n", r -> pThread -> nPid, pItem -> sKey) ;
if (pItem -> pProvider -> pProviderClass -> fGetContentSV)
if ((rc = (*pItem -> pProvider -> pProviderClass -> fGetContentSV) (r, pItem -> pProvider, pSVData, FALSE)) != ok)
{
Cache_FreeContent (r, pItem) ;
return rc ;
}
pItem -> pSVData = *pSVData ;
bUpdate = TRUE ;
}
else
*pSVData = pItem -> pSVData ;
if (bUpdate)
{
Cache_SetNotExpired (r, pItem) ;
}
else
{
if (r -> Component.Config.bDebug & dbgCache)
lprintf (r -> pApp, "[%d]CACHE: %s taken from cache\n", r -> pThread -> nPid, pItem -> sKey) ;
}
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_ReleaseContent */
/* */
/*!
* \_en
* Removes the read and/or write lock from the content.
*
* @param r Embperl request record
* @param pItem CacheItem which should be checked
* @return error code
* \endif
*
* \_de
* Gibt den Read und/oder Write Lock wieder frei.
*
* @param r Embperl request record
* @param pItem CacheItem welches berprft werden soll
* @return Fehlercode
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_ReleaseContent (/*in*/ req * r,
/*in*/ tCacheItem *pItem)
{
/* locking not yet implemented */
tCacheItem * pSubItem ;
int i ;
int numItems = pItem -> pDependsOn?ArrayGetSize (r -> pApp, pItem -> pDependsOn):0 ;
if (!pItem -> bCache)
Cache_FreeContent (r, pItem) ;
for (i = 0; i < numItems; i++)
{
pSubItem = pItem -> pDependsOn[i] ;
Cache_ReleaseContent (r, pSubItem) ;
}
return ok ;
}
/* ------------------------------------------------------------------------ */
/* */
/* Cache_FreeContent */
/* */
/*!
* \_en
* Free the cached data
*
* @param r Embperl request record
* @param pItem CacheItem
* @return error code
* \endif
*
* \_de
* Gibt die gecachten Daten frei
*
* @param r Embperl request record
* @param pItem CacheItem
* @return Fehlercode
* \endif
*
* ------------------------------------------------------------------------ */
int Cache_FreeContent (/*in*/ req * r,
/*in*/ tCacheItem *pItem)
{
epTHX_
int rc ;
if ((r -> Component.Config.bDebug & dbgCache) && (pItem -> pSVData || pItem -> pData || pItem -> xData))
lprintf (r -> pApp, "[%d]CACHE: Free content for %s\n", r -> pThread -> nPid, pItem -> sKey) ;
if (pItem -> pProvider -> pProviderClass -> fFreeContent)
if ((rc = (*pItem -> pProvider -> pProviderClass -> fFreeContent) (r, pItem)) != ok)
return rc ;
if (pItem -> pSVData)
{
SvREFCNT_dec (pItem -> pSVData) ;
pItem -> pSVData = NULL ;
}
pItem -> pData = NULL ;
pItem -> xData = 0 ;
return ok ;
}
|
