about summary refs log blame commit diff stats
path: root/svc/cache.go
blob: f887d0527c6d05106ee413526709fce2a9407d4d (plain) (tree)


















                                                                    
                                                      

        
               
                       
                   
            
              
              

 






                                            



                                                           


                     



                                               
                          
                             





                          


                                          

                                         

                                                                                         

 
                    




                                                  
                             
                                         
                                       
                                                    
                                     
         
                               

                                                 
                                                                                                                  
         

 



                                               
                          


                                     
 
                                                                 
                       
                                                                         
                       
 
                                                             

                                       

                                         
                                                                                      
 


                                                          
 

                                                                             
                               




                                                      
/*
Copyright (c) 2019 Ben Morrison (gbmor)

This file is part of Getwtxt.

Getwtxt 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 3 of the License, or
(at your option) any later version.

Getwtxt 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 Getwtxt.  If not, see <https://www.gnu.org/licenses/>.
*/

package svc // import "github.com/getwtxt/getwtxt/svc"

import (
	"bytes"
	"html/template"
	"io/ioutil"
	"os"
	"sync"
	"time"
)

// These functions and types pertain to the
// in-memory data being used by the registry
// service, such as:
//  - static assets (index.html, style.css)
//  - the registry itself (users, etc)
//  - list of other registries submitted

// RemoteRegistries holds a list of remote registries to
// periodically scrape for new users. The remote registries
// must have been added via POST like a user.
type RemoteRegistries struct {
	List []string
}

// staticAssets holda the rendered landing page
// as a byte slice, its on-disk mod time, the
// assets/style.css file as a byte slice, and
// its on-disk mod time.
type staticAssets struct {
	mu       sync.RWMutex
	index    []byte
	indexMod time.Time
	css      []byte
	cssMod   time.Time
}

// Renders the landing page template using
// the info supplied in the configuration
// file's "Instance" section.
func initTemplates() *template.Template {
	confObj.Mu.RLock()
	defer confObj.Mu.RUnlock()
	return template.Must(template.ParseFiles(confObj.AssetsDir + "/tmpl/index.html"))
}

func cacheUpdate() {
	// This clusterfuck of mutex read locks is
	// necessary to avoid deadlock. This mess
	// also avoids a panic that would occur
	// should twtxtCache be written to during
	// this loop.
	twtxtCache.Mu.RLock()
	for k := range twtxtCache.Users {
		twtxtCache.Mu.RUnlock()
		errLog("", twtxtCache.UpdateUser(k))
		twtxtCache.Mu.RLock()
	}
	twtxtCache.Mu.RUnlock()

	for _, v := range remoteRegistries.List {
		errLog("Error refreshing local copy of remote registry data: ", twtxtCache.CrawlRemoteRegistry(v))
	}
}

// pingAssets checks if the local static assets
// need to be re-cached. If they do, they are
// pulled back into memory from disk.
func pingAssets() {
	confObj.Mu.RLock()
	defer confObj.Mu.RUnlock()
	staticCache.mu.Lock()
	defer staticCache.mu.Unlock()

	cssStat, err := os.Stat(confObj.AssetsDir + "/style.css")
	errLog("", err)
	indexStat, err := os.Stat(confObj.AssetsDir + "/tmpl/index.html")
	errLog("", err)

	if !staticCache.indexMod.Equal(indexStat.ModTime()) {
		tmpls = initTemplates()

		var b []byte
		buf := bytes.NewBuffer(b)
		errLog("", tmpls.ExecuteTemplate(buf, "index.html", confObj.Instance))

		staticCache.index = buf.Bytes()
		staticCache.indexMod = indexStat.ModTime()
	}

	if !staticCache.cssMod.Equal(cssStat.ModTime()) {
		css, err := ioutil.ReadFile(confObj.AssetsDir + "/style.css")
		errLog("", err)

		staticCache.css = css
		staticCache.cssMod = cssStat.ModTime()
	}
}
href='#n147'>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
                                                                                         


                                   
          
             
                  

         

                                                                                      
 
                                  
          
             
                  




                                                                                                         



                                                                            
          
             
                                 

          

                                                                                                                
 
                                           
          
             
                           



                                             

                                                     
       
 
                  









                                                                              
                                                                

       
                                                          
                                  
                                                                                                        

                                                                        
                                      

 
                                                  
                                       
                                                  
                                           
                                                                          
                               
                                                          
                                                              
                                      
                                                                                   
                                                                                                    


                                    
                                                                  
                                                              

                                                                                   
                                                                                                    

       
                                                    




                                                                             
                                                                                          
                                                                         





                                                                                                      




                                                         
 

                                                                        
                                                                                              
                                                           
                            



                                         
                                    




                                   
                              








                                                      
                                                       

                                                    
                                      
                        

 
                                        
                       
                                                                              

 



                                      
                  


                                  
                                  

 


                                                                          


                                                                          

       
 
          




                       
//: make some functions more friendly by trying to auto-convert their ingredients to text

:(scenarios transform)
:(scenario rewrite_stashes_to_text)
def main [
  local-scope
  n:num <- copy 34
  stash n
]
+transform: {stash_2_0: ("address" "array" "character")} <- to-text-line {n: "number"}
+transform: stash {stash_2_0: ("address" "array" "character")}

:(scenario rewrite_traces_to_text)
def main [
  local-scope
  n:num <- copy 34
  trace 2, [app], n
]
+transform: {trace_2_2: ("address" "array" "character")} <- to-text-line {n: "number"}
+transform: trace {2: "literal"}, {"app": "literal-string"}, {trace_2_2: ("address" "array" "character")}

//: special case: rewrite attempts to stash contents of most arrays to avoid
//: passing addresses around

:(scenario rewrite_stashes_of_arrays)
def main [
  local-scope
  n:&:@:num <- new number:type, 3
  stash *n
]
+transform: {stash_2_0: ("address" "array" "character")} <- array-to-text-line {n: ("address" "array" "number")}
+transform: stash {stash_2_0: ("address" "array" "character")}

:(scenario ignore_stashes_of_static_arrays)
def main [
  local-scope
  n:@:num:3 <- create-array
  stash n
]
+transform: stash {n: ("array" "number" "3")}

:(scenario rewrite_stashes_of_recipe_header_products)
container foo [
  x:num
]
def bar -> x:foo [
  local-scope
  load-ingredients
  x <- merge 34
  stash x
]
+transform: stash {stash_2_0: ("address" "array" "character")}

//: misplaced; should be in instruction inserting/deleting transforms, but has
//: prerequisites: deduce_types_from_header and check_or_set_types_by_name
:(after "Transform.push_back(deduce_types_from_header)")
Transform.push_back(convert_ingredients_to_text);  // idempotent

:(code)
void convert_ingredients_to_text(const recipe_ordinal r) {
  recipe& caller = get(Recipe, r);
  trace(9991, "transform") << "--- convert some ingredients to text in recipe " << caller.name << end();
  // in recipes without named locations, 'stash' is still not extensible
  if (contains_numeric_locations(caller)) return;
  convert_ingredients_to_text(caller);
}

void convert_ingredients_to_text(recipe& caller) {
  vector<instruction> new_instructions;
  for (int i = 0;  i < SIZE(caller.steps);  ++i) {
    instruction& inst = caller.steps.at(i);
    // all these cases are getting hairy. how can we make this extensible?
    if (inst.name == "stash") {
      for (int j = 0;  j < SIZE(inst.ingredients);  ++j) {
        if (is_literal_text(inst.ingredients.at(j))) continue;
        ostringstream ingredient_name;
        ingredient_name << "stash_" << i << '_' << j << ":address:array:character";
        convert_ingredient_to_text(inst.ingredients.at(j), new_instructions, ingredient_name.str());
      }
    }
    else if (inst.name == "trace") {
      for (int j = /*skip*/2;  j < SIZE(inst.ingredients);  ++j) {
        if (is_literal_text(inst.ingredients.at(j))) continue;
        ostringstream ingredient_name;
        ingredient_name << "trace_" << i << '_' << j << ":address:array:character";
        convert_ingredient_to_text(inst.ingredients.at(j), new_instructions, ingredient_name.str());
      }
    }
    else if (inst.name_before_rewrite == "append") {
      // override only variants that try to append to a string
      // Beware: this hack restricts how much 'append' can be overridden. Any
      // new variants that match:
      //   append _:text, ___
      // will never ever get used.
      if (is_literal_text(inst.ingredients.at(0)) || is_mu_text(inst.ingredients.at(0))) {
        for (int j = /*skip base*/1;  j < SIZE(inst.ingredients);  ++j) {
          ostringstream ingredient_name;
          ingredient_name << "append_" << i << '_' << j << ":address:array:character";
          convert_ingredient_to_text(inst.ingredients.at(j), new_instructions, ingredient_name.str());
        }
      }
    }
    trace(9993, "transform") << to_string(inst) << end();
    new_instructions.push_back(inst);
  }
  caller.steps.swap(new_instructions);
}

// add an instruction to convert reagent 'r' to text in list 'out', then
// replace r with converted text
void convert_ingredient_to_text(reagent& r, vector<instruction>& out, const string& tmp_var) {
  if (!r.type) return;  // error; will be handled elsewhere
  if (is_mu_text(r)) return;
  // don't try to extend static arrays
  if (is_static_array(r)) return;
  instruction def;
  if (is_lookup_of_address_of_array(r)) {
    def.name = "array-to-text-line";
    reagent/*copy*/ tmp = r;
    drop_one_lookup(tmp);
    def.ingredients.push_back(tmp);
  }
  else {
    def.name = "to-text-line";
    def.ingredients.push_back(r);
  }
  def.products.push_back(reagent(tmp_var));
  trace(9993, "transform") << to_string(def) << end();
  out.push_back(def);
  r.clear();  // reclaim old memory
  r = reagent(tmp_var);
}

bool is_lookup_of_address_of_array(reagent/*copy*/ x) {
  if (x.type->atom) return false;
  if (x.type->left->name != "address") return false;
  if (!canonize_type(x)) return false;
  return is_mu_array(x);
}

bool is_static_array(const reagent& x) {
  // no canonize_type()
  return !x.type->atom && x.type->left->atom && x.type->left->name == "array";
}

:(scenarios run)
:(scenario append_other_types_to_text)
def main [
  local-scope
  n:num <- copy 11
  c:character <- copy 111/o
  a:text <- append [abc], 10, n, c
  expected:text <- new [abc1011o]
  10:bool/raw <- equal a, expected
]

//: Make sure that the new system is strictly better than just the 'stash'
//: primitive by itself.

:(scenario rewrite_stash_continues_to_fall_back_to_default_implementation)
# type without a to-text implementation
container foo [
  x:num
  y:num
]
def main [
  local-scope
  x:foo <- merge 34, 35
  stash x
]
+app: 34 35