gui FEATURE ask for missing schema when connecting to a device

When the backend is unable to get schema used by the device from the
local inventory as well as via get-schema from the server itself,
ask user (frontend) to upload the missing schema.

Author: rkrejci

backend/connections.py

@@ -38,7 +38,8 @@ def connect_sio_send(data):
 
 @socketio.on('device_auth_password')
 @socketio.on('hostcheck_result')
-def hostkey_check_answer(data):
+@socketio.on('getschema_result')
+def process_answer(data):
 	connect_sio_send(data)
 
 
@@ -88,7 +89,6 @@ def auth_common(session_id):
 		# wait for response from the frontend
 		e = connect_sio_data[session_id] = event.Event()
 		data = e.wait()
-		print(data)
 		result = data['password']
 	except Timeout:
 		# no response received within the timeout
@@ -105,17 +105,56 @@ def auth_common(session_id):
 
 
 def auth_password(username, hostname, priv):
-	print("auth_password callback")
 	socketio.emit('device_auth', {'id': priv, 'type': 'Password Authentication', 'msg': username + '@' + hostname}, callback = connect_sio_send)
 	return auth_common(priv)
 
 
 def auth_interactive(name, instruction, prompt, priv):
-	print("auth_interactive callback")
 	socketio.emit('device_auth', {'id': priv, 'type': name, 'msg': instruction, 'prompt': prompt}, callback = connect_sio_send)
 	return auth_common(priv)
 
 
+def getschema(name, revision, submod_name, submod_revision, priv):
+	# ask frontend/user for missing schema
+	params = {'id': priv['session_id'], 'name' : name, 'revision' : revision, 'submod_name' : submod_name, 'submod_revision' : submod_revision}
+	socketio.emit('getschema', params, callback = connect_sio_send)
+
+	result = (None, None)
+	timeout = Timeout(300)
+	try:
+		# wait for response from the frontend
+		e = connect_sio_data[priv['session_id']] = event.Event()
+		data = e.wait()
+		if data['filename'].lower()[len(data['filename']) - 5:] == '.yang':
+			format = yang.LYS_IN_YANG
+		elif data['filename'].lower()[len(data['filename']) - 4:] == '.yin':
+			format = yang.LYS_IN_YIN
+		else:
+			return result
+		result = (format, data['data'])
+	except Timeout:
+		# no response received within the timeout
+		log.info("socketio: getschema timeout.")
+	except (KeyError, AttributeError) as e:
+		# invalid response
+		log.error(e)
+		log.error("socketio: invalid getschema_result received.")
+	finally:
+		# we have the response
+		connect_sio_data.pop(priv['session_id'], None)
+		timeout.cancel()
+
+		# store the received file
+		try:
+			with open(os.path.join(INVENTORY, priv['user'].username, data['filename']), 'w') as schema_file:
+				schema_file.write(data['data'])
+		except Exception as e:
+			log.error(e)
+			pass
+
+	return result
+
+
 @auth.required()
 def connect():
 	session = auth.lookup(request.headers.get('lgui-Authorization', None))
@@ -136,6 +175,7 @@ def connect():
 		raise NetopeerException('Unknown device to connect to request.')
 
 	nc.setSearchpath(path)
+	nc.setSchemaCallback(getschema, session)
 
 	if 'password' in device:
 		ssh = nc.SSH(device['username'], password = device['password'])
@@ -148,7 +188,9 @@ def connect():
 	try:
 		ncs = nc.Session(device['hostname'], device['port'], ssh)
 	except Exception as e:
+		nc.setSchemaCallback(None)
 		return(json.dumps({'success': False, 'error-msg': str(e)}))
+	nc.setSchemaCallback(None)
 
 	if not user.username in sessions:
 		sessions[user.username] = {}

frontend/inventory/devices.component.ts

@@ -125,9 +125,12 @@ export class InventoryDevicesComponent implements OnInit {
         }
     }
 
-    socketAnswer(event: string, id:string, item: string, value: any) {
+    socketAnswer(event: string, id:string, item: string, value: any, item2: string = null, value2: any = null) {
         let data = {'id': id};
         data[item] = value;
+        if (item2) {
+            data[item2] = value2
+        }
         this.socketService.send(event, data);
     }
 
@@ -165,6 +168,16 @@ export class InventoryDevicesComponent implements OnInit {
             });
         });
 
+        this.socketService.subscribe('getschema').subscribe((message: any) => {
+            let modalRef = this.modalService.open(DialogueSchema, {centered: true, backdrop: 'static', keyboard: false});
+            modalRef.componentInstance.info = message;
+            modalRef.result.then((result) => {
+                this.socketAnswer('getschema_result', message['id'], 'filename', result['filename'], 'data', result['data']);
+            }, (reason) => {
+                this.socketAnswer('getschema_result', message['id'], 'filename', '', 'data', '');
+            });
+        });
+
         this.sessionsService.connect(device).subscribe(result => {
             if (result['success']) {
                 this.router.navigateByUrl('/netopeer/config');
@@ -226,4 +239,43 @@ export class DialoguePassword implements OnInit {
     ngOnInit(): void {
         document.getElementById('device_password').focus();
     }
-}
+}
+
+@Component({
+    selector: 'ngbd-modal-content',
+    styleUrls: ['../netopeer.scss'],
+    template: `<div class="modal-header">
+        <h4 class="modal-title">Missing YANG Schema</h4>
+    </div>
+    <div class="modal-body">
+        <label>The device utilize YANG schema <b>{{info.name}}</b> <ng-container *ngIf="info.revision">in revision <b>{{info.revision}}</b></ng-container>.<br/>
+        <span *ngIf="!info['submod_name']">Please provide this schema.</span>
+        <span *ngIf="info['submod_name']">Please provide submodule <b>{{info['submod_name']}}</b> <ng-container *ngIf="info['submod_revision']">in revision <b>{{info['submod_revision']}}</b></ng-container> for this schema.</span>
+        </label><br/>
+        <input id="uploadSchema" #uploadSchema type="file" (change)="upload(uploadSchema.files[0])" name="schema" placeholder="Upload schema"/>
+    </div>
+    <div class="modal-footer">
+        <button class="btn btn-light" (click)="activeModal.dismiss(null)">cancel</button>
+    </div>`
+})
+export class DialogueSchema implements OnInit {
+    @Input() info;
+    password = '';
+
+    constructor(public activeModal: NgbActiveModal) { }
+
+    upload(schema: File) {
+        let reader = new FileReader();
+
+        console.log(schema);
+        reader.onloadend = () => {
+            //console.log(reader.result);
+            this.activeModal.close({'filename': schema.name, 'data': reader.result});
+        };
+        reader.readAsText(schema);
+    }
+
+    ngOnInit(): void {
+        document.getElementById('uploadSchema').focus();
+    }
+}

frontend/inventory/schemas.component.html

@@ -6,7 +6,7 @@
   <div *ngIf="addingSchema">
     <hr/>
     <div class="buttons">
-      <input #uploadSchema type="file" (change)="upload(uploadSchema.files[0])" name="schema" placeholder="Upload schema"/>      
+      <input #uploadSchema type="file" (change)="upload(uploadSchema.files[0])" name="schema" placeholder="Upload schema"/>
       <span [ngSwitch]="addingResult">
         <span *ngSwitchCase="0" class="msg-rounded msg-failure"><span class="msg-close" (click)="addingResult=-1">x</span>Parsing {{uploadSchema.value.replace("C:\\fakepath\\","")}} failed.</span>
         <span *ngSwitchCase="1" class="msg-rounded msg-success"><span class="msg-close" (click)="addingResult=-1">x</span>Schema {{uploadSchema.value.replace("C:\\fakepath\\","")}} successfully added.</span>

frontend/netopeer.module.ts

@@ -19,7 +19,7 @@ import { NetopeerComponent } from './netopeer.component';
 import { DashboardComponent } from './dashboard.component';
 import { InventoryComponent } from './inventory/inventory.component';
 import { InventorySchemasComponent } from './inventory/schemas.component';
-import { InventoryDevicesComponent, DialogueHostcheck, DialoguePassword } from './inventory/devices.component';
+import { InventoryDevicesComponent, DialogueHostcheck, DialoguePassword, DialogueSchema } from './inventory/devices.component';
 import { ConfigComponent } from './config/config.component';
 import { TreeView, TreeNode, TreeLeaflistValue, TreeIndent, TreeCreate, TreeEdit, TreeScrollTo, CheckLeafValue } from './config/tree.component';
 import { YANGComponent, YANGModule, YANGIdentity, YANGFeature, YANGTypedef, YANGType, YANGRestriction, YANGNode, YANGIffeature } from './yang/yang.component';
@@ -126,6 +126,7 @@ const routes: Routes = [
     PluginsComponent,
     DialogueHostcheck,
     DialoguePassword,
+    DialogueSchema,
     NoPrefixPipe,
     PrefixOnlyPipe,
     PatternHighlightPipe
@@ -139,7 +140,8 @@ const routes: Routes = [
   entryComponents : [
     NetopeerComponent,
     DialogueHostcheck,
-    DialoguePassword
+    DialoguePassword,
+    DialogueSchema
   ]
 })
 export class NetopeerModule { }