Client: Rename "permit" operation to "publish" (closes #128)

"Permit" button is now labeled "publish" because local jobs may always
start, even if the button is not pressed.

share/bitwrk-client/htroot/js/activity.js

@@ -73,7 +73,7 @@ function setActivities(node, activitiesjson, serverUrl) {
 						+ '_phase_dummy_' + '<div class="info"></div>';
 			} else {
 				item.innerHTML = '<div class="type"></div>'
-						+ '<button class="closebtn btn btn-primary btn-xs">Permit</button>'
+						+ '<button class="closebtn btn btn-primary btn-xs">Publish</button>'
 						+ '<div class="article"></div>' + '_phase_dummy_'
 						+ '<div class="info"></div>';
 			}

src/github.com/indyjo/bitwrk-client/activity.go

@@ -43,9 +43,9 @@ type Activity interface {
 	GetKey() ActivityKey
 	GetState() *ActivityState
 
-	// Permit the activity.
-	// Returns true if the call caused the activity to be accepted.
-	Permit(identity *bitcoin.KeyPair, price money.Money) bool
+	// Publish the activity.
+	// Returns true if the call caused the activity to be published.
+	Publish(identity *bitcoin.KeyPair, price money.Money) bool
 
 	// Forbid the activity.
 	// Returns true if the call caused the activity to be rejected.
@@ -59,7 +59,7 @@ type ActivityState struct {
 	Type        string
 	Article     bitwrk.ArticleId
 	Alive       bool // Whether the activity is still alive
-	Accepted    bool // Whether the activity was permitted
+	Accepted    bool // true iff the activity can no longer be published
 	Rejected    bool
 	Amount      money.Money
 	BidId, TxId string

src/github.com/indyjo/bitwrk-client/cmd/bitwrk-client/client_ui.go

@@ -194,7 +194,6 @@ func handleRevokeMandate(r *http.Request) error {
 	return nil
 }
 
-
 // Simply forward the request to the BitWrk service
 func handleRequestDepositAddress(r *http.Request) error {
 	if nonce, err := protocol.GetNonce(); err != nil {

src/github.com/indyjo/bitwrk-client/mandate.go

@@ -24,17 +24,18 @@ import (
 	"time"
 )
 
+// Automates granting permission to (or publishing of, as it is now called) a trade.
 type Mandate struct {
-	mutex         sync.Mutex
-	expired       bool
-	Identity      *bitcoin.KeyPair
-	BidType       bitwrk.BidType // Buy or Sell
-	Article       bitwrk.ArticleId
-	Price         money.Money
-	UseTradesLeft bool
-	TradesLeft    int
-	UseUntil      bool
-	Until         time.Time
+	mutex         sync.Mutex       // Protects every access to the mandate's state
+	expired       bool             // Initially false
+	Identity      *bitcoin.KeyPair // Which identity to pass to the publish operation
+	BidType       bitwrk.BidType   // Buy or Sell
+	Article       bitwrk.ArticleId // Which article to buy or sell
+	Price         money.Money      // Which price to bid/ask for
+	UseTradesLeft bool             // Whether TradesLeft should be regarded
+	TradesLeft    int              // Remaining number of trades until expiration
+	UseUntil      bool             // Whether Until should be regarded
+	Until         time.Time        // Time at which mandate should expire
 }
 
 // Shown to user
@@ -48,6 +49,7 @@ type MandateInfo struct {
 	Until         time.Time
 }
 
+// Returns true if the mandate has expired
 func (m *Mandate) Expired() bool {
 	m.mutex.Lock()
 	defer m.mutex.Unlock()
@@ -109,7 +111,7 @@ func (m *Mandate) Apply(activity Activity, now time.Time) bool {
 		return false
 	}
 
-	result := t.Permit(m.Identity, m.Price)
+	result := t.Publish(m.Identity, m.Price)
 	if result {
 		m.TradesLeft--
 	}

src/github.com/indyjo/bitwrk-client/trade.go

@@ -40,11 +40,11 @@ type Trade struct {
 
 	alive             bool   // Set to false on end of life
 	clearanceDenied   bool   // Set to true on Forbid
-	clearedForTrade   bool   // Set to true on Permit
+	published         bool   // Set to true on Publish
 	localMatch        *Trade // Set to a matching trade on local match
-	awaitingClearance bool   // Set to false on local match, Forbid and Permit
+	awaitingClearance bool   // Set to false on local match, Forbid and Publish
 
-	// Information stored on Permit(...)
+	// Information stored on Publish(...)
 	identity *bitcoin.KeyPair
 	price    money.Money
 
@@ -129,7 +129,7 @@ func (t *Trade) awaitClearance(log bitwrk.Logger, interrupt <-chan bool) error {
 		fmt.Errorf("Clearance denied")
 		return ErrNoPermission
 	} else {
-		if t.clearedForTrade {
+		if t.published {
 			log.Printf("Got trade clearance. Price: %v", t.price)
 		} else if t.localMatch != nil {
 			log.Printf("Got local clearance. Matched with #%v.", t.localMatch.key)
@@ -426,15 +426,15 @@ func (t *Trade) GetState() *ActivityState {
 	return result
 }
 
-func (t *Trade) Permit(identity *bitcoin.KeyPair, price money.Money) bool {
+func (t *Trade) Publish(identity *bitcoin.KeyPair, price money.Money) bool {
 	t.condition.L.Lock()
 	defer t.condition.L.Unlock()
 	if !t.awaitingClearance {
 		return false
 	}
 	t.identity = identity
 	t.price = price
-	t.clearedForTrade = true
+	t.published = true
 	t.awaitingClearance = false
 	t.condition.Broadcast()
 	return true