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
|
package papi
import (
"fmt"
"strings"
"github.com/akamai/AkamaiOPEN-edgegrid-golang/client-v1"
edge "github.com/akamai/AkamaiOPEN-edgegrid-golang/edgegrid"
)
// Rules is a collection of property rules
type Rules struct {
client.Resource
AccountID string `json:"accountId"`
ContractID string `json:"contractId"`
GroupID string `json:"groupId"`
PropertyID string `json:"propertyId"`
PropertyVersion int `json:"propertyVersion"`
Etag string `json:"etag"`
RuleFormat string `json:"ruleFormat"`
Rule *Rule `json:"rules"`
Errors []*RuleErrors `json:"errors,omitempty"`
}
// NewRules creates a new Rules
func NewRules() *Rules {
rules := &Rules{}
rules.Rule = NewRule()
rules.Rule.Name = "default"
rules.Init()
return rules
}
// PreMarshalJSON is called before JSON marshaling
//
// See: jsonhooks-v1/json.Marshal()
func (rules *Rules) PreMarshalJSON() error {
rules.Errors = nil
return nil
}
// GetRules populates Rules with rule data for a given property
//
// See: Property.GetRules
// API Docs: https://developer.akamai.com/api/luna/papi/resources.html#getaruletree
// Endpoint: GET /papi/v1/properties/{propertyId}/versions/{propertyVersion}/rules/{?contractId,groupId}
func (rules *Rules) GetRules(property *Property, correlationid string) error {
req, err := client.NewRequest(
Config,
"GET",
fmt.Sprintf(
"/papi/v1/properties/%s/versions/%d/rules",
property.PropertyID,
property.LatestVersion,
),
nil,
)
if err != nil {
return err
}
edge.PrintHttpRequestCorrelation(req, true, correlationid)
res, err := client.Do(Config, req)
if err != nil {
return err
}
edge.PrintHttpResponseCorrelation(res, true, correlationid)
if client.IsError(res) {
return client.NewAPIError(res)
}
if err = client.BodyJSON(res, rules); err != nil {
return err
}
return nil
}
// GetRulesDigest fetches the Etag for a rule tree
//
// See: Property.GetRulesDigest()
// API Docs: https://developer.akamai.com/api/luna/papi/resources.html#getaruletreesdigest
// Endpoint: HEAD /papi/v1/properties/{propertyId}/versions/{propertyVersion}/rules/{?contractId,groupId}
func (rules *Rules) GetRulesDigest(property *Property, correlationid string) (string, error) {
req, err := client.NewRequest(
Config,
"HEAD",
fmt.Sprintf(
"/papi/v1/properties/%s/versions/%d/rules",
property.PropertyID,
property.LatestVersion,
),
nil,
)
if err != nil {
return "", err
}
edge.PrintHttpRequestCorrelation(req, true, correlationid)
res, err := client.Do(Config, req)
if err != nil {
return "", err
}
edge.PrintHttpResponseCorrelation(res, true, correlationid)
if client.IsError(res) {
return "", client.NewAPIError(res)
}
return res.Header.Get("Etag"), nil
}
// Save creates/updates a rule tree for a property
//
// API Docs: https://developer.akamai.com/api/luna/papi/resources.html#putpropertyversionrules
// Endpoint: PUT /papi/v1/properties/{propertyId}/versions/{propertyVersion}/rules{?contractId,groupId}
func (rules *Rules) Save(correlationid string) error {
rules.Errors = []*RuleErrors{}
req, err := client.NewJSONRequest(
Config,
"PUT",
fmt.Sprintf(
"/papi/v1/properties/%s/versions/%d/rules",
rules.PropertyID,
rules.PropertyVersion,
),
rules,
)
if err != nil {
return err
}
edge.PrintHttpRequestCorrelation(req, true, correlationid)
res, err := client.Do(Config, req)
if err != nil {
return err
}
edge.PrintHttpResponseCorrelation(res, true, correlationid)
if client.IsError(res) {
return client.NewAPIError(res)
}
if err = client.BodyJSON(res, rules); err != nil {
return err
}
if len(rules.Errors) != 0 {
return ErrorMap[ErrInvalidRules]
}
return nil
}
// Freeze pins a properties rule set to a specific rule set version
func (rules *Rules) Freeze(format string) error {
rules.Errors = []*RuleErrors{}
req, err := client.NewJSONRequest(
Config,
"PUT",
fmt.Sprintf(
"/papi/v1/properties/%s/versions/%d/rules",
rules.PropertyID,
rules.PropertyVersion,
),
rules,
)
if err != nil {
return err
}
edge.PrintHttpRequest(req, true)
req.Header.Set("Content-Type", fmt.Sprintf("application/vnd.akamai.papirules.%s+json", format))
res, err := client.Do(Config, req)
if err != nil {
return err
}
edge.PrintHttpResponse(res, true)
if client.IsError(res) {
return client.NewAPIError(res)
}
if err = client.BodyJSON(res, rules); err != nil {
return err
}
if len(rules.Errors) != 0 {
return ErrorMap[ErrInvalidRules]
}
return nil
}
// Rule represents a property rule resource
type Rule struct {
client.Resource
Depth int `json:"-"`
Name string `json:"name"`
Criteria []*Criteria `json:"criteria,omitempty"`
Behaviors []*Behavior `json:"behaviors,omitempty"`
Children []*Rule `json:"children,omitempty"`
Comments string `json:"comments,omitempty"`
CriteriaLocked bool `json:"criteriaLocked,omitempty"`
CriteriaMustSatisfy RuleCriteriaMustSatisfyValue `json:"criteriaMustSatisfy,omitempty"`
UUID string `json:"uuid,omitempty"`
Variables []*Variable `json:"variables,omitempty"`
AdvancedOverride string `json:"advancedOverride,omitempty"`
Options struct {
IsSecure bool `json:"is_secure,omitempty"`
} `json:"options,omitempty"`
CustomOverride *CustomOverride `json:"customOverride,omitempty"`
}
// NewRule creates a new Rule
func NewRule() *Rule {
rule := &Rule{}
rule.Init()
return rule
}
// MergeBehavior merges a behavior into a rule
//
// If the behavior already exists, it's options are merged with the existing
// options.
func (rule *Rule) MergeBehavior(behavior *Behavior) {
for _, existingBehavior := range rule.Behaviors {
if behavior.Name == "cpCode" || behavior.Name == "origin" {
if existingBehavior.Name == behavior.Name {
existingBehavior.MergeOptions(behavior.Options)
return
}
}
}
rule.Behaviors = append(rule.Behaviors, behavior)
}
// AddBehavior adds a behavior to the rule
//
// If the behavior already exists it is replaced with the given behavior
func (rule *Rule) AddBehavior(behavior *Behavior) {
/*for key, existingBehavior := range rule.Behaviors {
if existingBehavior.Name == behavior.Name {
rule.Behaviors[key] = behavior
return
}
}*/
rule.Behaviors = append(rule.Behaviors, behavior)
}
// MergeCriteria merges a criteria into a rule
//
// If the criteria already exists, it's options are merged with the existing
// options.
func (rule *Rule) MergeCriteria(criteria *Criteria) {
/*for _, existingCriteria := range rule.Criteria {
if existingCriteria.Name == criteria.Name {
existingCriteria.MergeOptions(criteria.Options)
return
}
}*/
rule.Criteria = append(rule.Criteria, criteria)
}
// AddCriteria add a criteria to a rule
//
// If the criteria already exists, it is replaced with the given criteria.
func (rule *Rule) AddCriteria(criteria *Criteria) {
/*for key, existingCriteria := range rule.Criteria {
if existingCriteria.Name == criteria.Name {
rule.Criteria[key] = criteria
return
}
}*/
rule.Criteria = append(rule.Criteria, criteria)
}
// MergeChildRule adds a child rule to this rule
//
// If the rule already exists, criteria, behaviors, and child rules are added to
// the existing rule.
func (rule *Rule) MergeChildRule(childRule *Rule) {
/*for key, existingChildRule := range rule.Children {
if existingChildRule.Name == childRule.Name {
for _, behavior := range childRule.Behaviors {
rule.Children[key].MergeBehavior(behavior)
}
for _, criteria := range childRule.Criteria {
rule.Children[key].MergeCriteria(criteria)
}
for _, child := range childRule.Children {
rule.Children[key].MergeChildRule(child)
}
return
}
}*/
rule.Children = append(rule.Children, childRule)
}
// AddChildRule adds a rule as a child of this rule
//
// If the rule already exists, it is replaced by the given rule.
func (rule *Rule) AddChildRule(childRule *Rule) {
/*for key, existingChildRule := range rule.Children {
if existingChildRule.Name == childRule.Name {
rule.Children[key] = childRule
return
}
}*/
rule.Children = append(rule.Children, childRule)
}
// AddVariable adds a variable as a child of this rule
//
// If the rule already exists, it is replaced by the given rule.
func (rule *Rule) AddVariable(variable *Variable) {
for key, existingVariable := range rule.Variables {
if existingVariable.Name == variable.Name {
rule.Variables[key] = variable
return
}
}
rule.Variables = append(rule.Variables, variable)
}
// FindBehavior locates a specific behavior by path
func (rules *Rules) FindBehavior(path string) (*Behavior, error) {
if len(path) <= 1 {
return nil, ErrorMap[ErrInvalidPath]
}
rule, err := rules.FindParentRule(path)
if err != nil {
return nil, err
}
sep := "/"
segments := strings.Split(path, sep)
behaviorName := strings.ToLower(segments[len(segments)-1])
for _, behavior := range rule.Behaviors {
if strings.ToLower(behavior.Name) == behaviorName {
return behavior, nil
}
}
return nil, ErrorMap[ErrBehaviorNotFound]
}
// FindCriteria locates a specific Critieria by path
func (rules *Rules) FindCriteria(path string) (*Criteria, error) {
if len(path) <= 1 {
return nil, ErrorMap[ErrInvalidPath]
}
rule, err := rules.FindParentRule(path)
if err != nil {
return nil, err
}
sep := "/"
segments := strings.Split(path, sep)
criteriaName := strings.ToLower(segments[len(segments)-1])
for _, criteria := range rule.Criteria {
if strings.ToLower(criteria.Name) == criteriaName {
return criteria, nil
}
}
return nil, ErrorMap[ErrCriteriaNotFound]
}
// FindVariable locates a specific Variable by path
func (rules *Rules) FindVariable(path string) (*Variable, error) {
if len(path) <= 1 {
return nil, ErrorMap[ErrInvalidPath]
}
rule, err := rules.FindParentRule(path)
if err != nil {
return nil, err
}
sep := "/"
segments := strings.Split(path, sep)
variableName := strings.ToLower(segments[len(segments)-1])
for _, variable := range rule.Variables {
if strings.ToLower(variable.Name) == variableName {
return variable, nil
}
}
return nil, ErrorMap[ErrVariableNotFound]
}
// FindRule locates a specific rule by path
func (rules *Rules) FindRule(path string) (*Rule, error) {
if path == "" {
return rules.Rule, nil
}
sep := "/"
segments := strings.Split(path, sep)
currentRule := rules.Rule
for _, segment := range segments {
found := false
for _, rule := range currentRule.Children {
if strings.ToLower(rule.Name) == segment {
currentRule = rule
found = true
}
}
if found != true {
return nil, ErrorMap[ErrRuleNotFound]
}
}
return currentRule, nil
}
// Find the parent rule for a given rule, criteria, or behavior path
func (rules *Rules) FindParentRule(path string) (*Rule, error) {
sep := "/"
segments := strings.Split(strings.ToLower(strings.TrimPrefix(path, sep)), sep)
parentPath := strings.Join(segments[0:len(segments)-1], sep)
return rules.FindRule(parentPath)
}
// Criteria represents a rule criteria resource
type Criteria struct {
client.Resource
Name string `json:"name"`
Options OptionValue `json:"options"`
UUID string `json:"uuid,omitempty"`
Locked bool `json:"locked,omitempty"`
}
// NewCriteria creates a new Criteria
func NewCriteria() *Criteria {
criteria := &Criteria{Options: OptionValue{}}
criteria.Init()
return criteria
}
// MergeOptions merges the given options with the existing options
/*func (criteria *Criteria) MergeOptions(newOptions OptionValue) {
options := make(map[string]interface{})
for k, v := range criteria.Options {
options[k] = v
}
for k, v := range newOptions {
options[k] = v
}
criteria.Options = OptionValue(options)
}
*/
// Behavior represents a rule behavior resource
type Behavior struct {
client.Resource
Name string `json:"name"`
Options OptionValue `json:"options"`
Locked bool `json:"locked,omitempty"`
UUID string `json:"uuid,omitempty"`
}
// NewBehavior creates a new Behavior
func NewBehavior() *Behavior {
behavior := &Behavior{Options: OptionValue{}}
behavior.Init()
return behavior
}
// MergeOptions merges the given options with the existing options
func (behavior *Behavior) MergeOptions(newOptions OptionValue) {
options := make(map[string]interface{})
for k, v := range behavior.Options {
options[k] = v
}
for k, v := range newOptions {
options[k] = v
}
behavior.Options = OptionValue(options)
}
// OptionValue represents a generic option value
//
// OptionValue is a map with string keys, and any
// type of value. You can nest OptionValues as necessary
// to create more complex values.
type OptionValue map[string]interface{}
type Variable struct {
client.Resource
Name string `json:"name"`
Value string `json:"value"`
Description string `json:"description"`
Hidden bool `json:"hidden"`
Sensitive bool `json:"sensitive"`
}
// NewVariable creates a new Variable
func NewVariable() *Variable {
variable := &Variable{}
variable.Init()
return variable
}
// RuleErrors represents an validate error returned for a rule
type RuleErrors struct {
client.Resource
Type string `json:"type"`
Title string `json:"title"`
Detail string `json:"detail"`
Instance string `json:"instance"`
BehaviorName string `json:"behaviorName"`
}
// NewRuleErrors creates a new RuleErrors
func NewRuleErrors() *RuleErrors {
ruleErrors := &RuleErrors{}
ruleErrors.Init()
return ruleErrors
}
type RuleCriteriaMustSatisfyValue string
const (
RuleCriteriaMustSatisfyAll RuleCriteriaMustSatisfyValue = "all"
RuleCriteriaMustSatisfyAny RuleCriteriaMustSatisfyValue = "any"
)
|