update docs with latest changes

SECURITY.md

@@ -0,0 +1,22 @@
+# Security Policy
+
+> Note that the most up to date code is located in the develop branch. Every 6 months to 12 months, the develop branch is merged to the master branch and new releases are integrated.
+
+
+## Reporting a Vulnerability
+
+**Please do not report security vulnerabilities through public pyRevit GitHub issues, discussions, or pull requests.**
+
+Instead, please send an email to eirannejad+pyrevitsecurity[@]gmail.com .
+
+Please include as much of the information listed below as you can to help us better understand and resolve the issue:
+
+- The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.

extensions/pyRevitTools.extension/pyRevit.tab/Drawing Set.panel/Keynotes.pushbutton/script.py

@@ -10,6 +10,7 @@
 import shutil
 import math
 from collections import defaultdict
+from natsort import natsorted
 
 from pyrevit import HOST_APP
 from pyrevit import framework
@@ -272,7 +273,7 @@ def pick_parent(self, sender, args):
             available_parents.remove(self.active_key)
         # prompt to select a record
         new_parent = forms.SelectFromList.show(
-            available_parents,
+            natsorted(available_parents),
             title='Select Parent',
             multiselect=False
             )

extensions/pyRevitTools.extension/pyRevit.tab/Drawing Set.panel/Sheets.pulldown/Set Crop Region To Selected Shape.pushbutton/script.py

@@ -9,18 +9,6 @@
 # todo: ask to delete polygon when done
 
 DEBUG = False
-MAKELINES = False
-
-selection = revit.get_selection()
-
-
-class TransformationMatrix:
-    def __init__(self):
-        pass
-
-
-transmatrix = TransformationMatrix()
-
 
 def createreversedcurve(orig):
     # Create a new curve with the same geometry in the reverse direction.
@@ -86,26 +74,39 @@ def sortcurvescontiguous(origcurves):
     return curves
 
 
-def sheet_to_view_transform(sheetcoord):
-    global transmatrix
-    newx = \
-        transmatrix.destmin.X \
-        + (((sheetcoord.X - transmatrix.sourcemin.X)
-            * (transmatrix.destmax.X - transmatrix.destmin.X))
-           / (transmatrix.sourcemax.X - transmatrix.sourcemin.X))
+def get_transformation(view_port, view, view_crop_shape):
+    def _min_mix(_shape):
+        _max, _min = (lambda x: ([-x] * 3, [x-1] * 3))(2**63) # (2) 1x3 vectors with max/min 64 bit numbers
+        _cl = _shape
+        for _l in _cl:
+            _p_zero = _l.GetEndPoint(0)
+            _p_one = _l.GetEndPoint(1)
+            for i in range(3):
+                _min[i] = min(_min[i], _p_zero[i], _p_one[i])
+                _max[i] = max(_max[i], _p_zero[i], _p_one[i])
+        return DB.XYZ(*_max), DB.XYZ(*_min)
+
+    view_crop_max, view_crop_min = _min_mix(view_crop_shape)
+    sheet_max, sheet_min = view_port.GetBoxOutline().MaximumPoint, view_port.GetBoxOutline().MinimumPoint
+
+    view_crop_center = (view_crop_max + view_crop_min) * 0.5
+    sheet_center = (sheet_max + sheet_min) * 0.5
 
-    newy = \
-        transmatrix.destmin.Y \
-        + (((sheetcoord.Y - transmatrix.sourcemin.Y)
-            * (transmatrix.destmax.Y - transmatrix.destmin.Y))
-           / (transmatrix.sourcemax.Y - transmatrix.sourcemin.Y))
+    # transforms all points on the sheet to be relative to center of sheet viewport
+    sheet_transform = DB.Transform.CreateTranslation(-sheet_center)
 
-    return DB.XYZ(newx, newy, 0.0)
+    # transforms all sheet points to be relative to the model views crop center
+    basis_transform = DB.Transform.CreateTranslation(view_crop_center)
+    basis_transform.BasisX = view.RightDirection * view.Scale
+    basis_transform.BasisY = view.UpDirection * view.Scale
+    basis_transform.BasisZ = view.ViewDirection * view.Scale
+
+    # return composition of transforms going from right to left (sheet transform first, then basis transform)
+    return  basis_transform * sheet_transform
 
 
 def set_crop_boundary():
     selview = selvp = None
-    vpboundaryoffset = 0.01
     selviewports = []
     selboundary = []
 
@@ -115,6 +116,7 @@ def set_crop_boundary():
             selviewports.append(el)
         elif isinstance(el, DB.CurveElement):
             selboundary.append(el)
+
     if len(selviewports) > 0:
         selvp = selviewports[0]
         selview = revit.doc.GetElement(selvp.ViewId)
@@ -130,75 +132,32 @@ def set_crop_boundary():
         with revit.Transaction('Activate Crop Box'):
             selview.CropBoxActive = True
 
-    # get vp min max points in sheetUCS
-    ol = selvp.GetBoxOutline()
-    vptempmin = ol.MinimumPoint
-    vpmin = DB.XYZ(vptempmin.X + vpboundaryoffset,
-                   vptempmin.Y + vpboundaryoffset,
-                   0.0)
-
-    vptempmax = ol.MaximumPoint
-    vpmax = DB.XYZ(vptempmax.X - vpboundaryoffset,
-                   vptempmax.Y - vpboundaryoffset,
-                   0.0)
-    if DEBUG:
-        print('VP MIN MAX: {0}\n'
-              '            {1}\n'.format(vpmin, vpmax))
-
-    # get view min max points in modelUCS.
-    modelucsx = []
-    modelucsy = []
     crsm = selview.GetCropRegionShapeManager()
-    cl = crsm.GetCropShape()[0]
-    for l in cl:
-        modelucsx.append(l.GetEndPoint(0).X)
-        modelucsy.append(l.GetEndPoint(0).Y)
-        if DEBUG:
-            print('CROP LINE POINTS: {0}\n'
-                  '                  {1}\n'.format(l.GetEndPoint(0),
-                                                   l.GetEndPoint(1)))
-
-    cropmin = DB.XYZ(min(modelucsx), min(modelucsy), 0.0)
-    cropmax = DB.XYZ(max(modelucsx), max(modelucsy), 0.0)
-    if DEBUG:
-        print('CROP MIN MAX: {0}\n'
-              '              {1}\n'.format(cropmin, cropmax))
-    if DEBUG:
-        print('VIEW BOUNDING BOX ON THIS SHEET: {0}\n'
-              '                                 {1}\n'
-              .format(selview.BoundingBox[selview].Min,
-                      selview.BoundingBox[selview].Max))
-    transmatrix.sourcemin = vpmin
-    transmatrix.sourcemax = vpmax
-    transmatrix.destmin = cropmin
-    transmatrix.destmax = cropmax
+    view_crop = crsm.GetCropShape()[0]
 
     with revit.Transaction('Set Crop Region'):
+        selview.AreAnnotationCategoriesHidden = True
+
         curveloop = []
         for bl in selboundary:
-            newlinestart = sheet_to_view_transform(bl.GeometryCurve.GetEndPoint(0))
-            newlineend = sheet_to_view_transform(bl.GeometryCurve.GetEndPoint(1))
+            newlinestart = bl.GeometryCurve.GetEndPoint(0)
+            newlineend = bl.GeometryCurve.GetEndPoint(1)
             geomLine = DB.Line.CreateBound(newlinestart, newlineend)
-            if MAKELINES:
-                sketchp = selview.SketchPlane
-                mline = revit.doc.Create.NewModelCurve(geomLine, sketchp)
             curveloop.append(geomLine)
-            if DEBUG:
-                print('VP POLY LINE POINTS: {0}\n'
-                      '                     {1}\n'
-                      .format(bl.GeometryCurve.GetEndPoint(0),
-                              bl.GeometryCurve.GetEndPoint(1)))
-
-            if DEBUG:
-                print('NEW CROP LINE POINTS: {0}\n'
-                      '                      {1}\n'.format(newlinestart,
-                                                           newlineend))
         sortedcurves = sortcurvescontiguous(curveloop)
+
         if sortedcurves:
-            crsm.SetCropShape(DB.CurveLoop.Create(List[DB.Curve](sortedcurves)))
+            crop_shape = DB.CurveLoop.Create(List[DB.Curve](sortedcurves))
         else:
             forms.alert('Curves must be in a closed loop.')
 
+        transform = get_transformation(selvp, selview, view_crop)
+        crop_shape = DB.CurveLoop.CreateViaTransform(crop_shape, transform)
+        crsm.SetCropShape(crop_shape)
+        selview.AreAnnotationCategoriesHidden = False
+
+
+selection = revit.get_selection()
 
 if selection:
     set_crop_boundary()

extensions/pyRevitTools.extension/pyRevit.tab/Project.panel/ptools.stack/Links.pulldown/Create Workset For Linked Element.pushbutton/script.py

@@ -22,9 +22,12 @@
                 revit.doc.EnableWorksharing('Shared Levels and Grids',
                                             'Workset1')
             with revit.Transaction('Create Workset for linked model'):
-                newWs = DB.Workset.Create(revit.doc, linkedModelName)
-                worksetParam = \
-                    el.Parameter[DB.BuiltInParameter.ELEM_PARTITION_PARAM]
-                worksetParam.Set(newWs.Id.IntegerValue)
+                try:
+                    newWs = DB.Workset.Create(revit.doc, linkedModelName)
+                    worksetParam = \
+                        el.Parameter[DB.BuiltInParameter.ELEM_PARTITION_PARAM]
+                    worksetParam.Set(newWs.Id.IntegerValue)
+                except Exception as e:
+                    print('Workset: {} already exists\nError: {}'.format(linkedModelName,e))
 else:
     forms.alert('At least one linked element must be selected.')

extensions/pyRevitTools.extension/pyRevit.tab/Selection.panel/select.stack/Select.pulldown/Find And Select Entities Without Tags.pushbutton/script.py

@@ -16,7 +16,6 @@
     forms.alert("You're on a Sheet. Activate a model view please.",
                 exitscript=True)
 
-
 options = {
     'Rooms': Taggable(
         tag_type=DB.BuiltInCategory.OST_RoomTags,
@@ -95,6 +94,66 @@
         tag_type=DB.BuiltInCategory.OST_StructuralFoundationTags,
         element_type=DB.BuiltInCategory.OST_StructuralFoundation
         ),
+    'Air terminals': Taggable(
+        tag_type=DB.BuiltInCategory.OST_DuctTerminalTags,
+        element_type=DB.BuiltInCategory.OST_DuctTerminal
+        ),
+    'Communication devices': Taggable(
+        tag_type=DB.BuiltInCategory.OST_CommunicationDeviceTags,
+        element_type=DB.BuiltInCategory.OST_CommunicationDevices
+        ),
+    'Data devices': Taggable(
+        tag_type=DB.BuiltInCategory.OST_DataDeviceTags,
+        element_type=DB.BuiltInCategory.OST_DataDevices
+        ),
+    'Duct accessories': Taggable(
+        tag_type=DB.BuiltInCategory.OST_DuctAccessoryTags,
+        element_type=DB.BuiltInCategory.OST_DuctAccessory
+        ),
+    'Electrical fixtures': Taggable(
+        tag_type=DB.BuiltInCategory.OST_ElectricalFixtureTags,
+        element_type=DB.BuiltInCategory.OST_ElectricalFixtures
+        ),
+    'Fire alarm devices': Taggable(
+        tag_type=DB.BuiltInCategory.OST_FireAlarmDeviceTags,
+        element_type=DB.BuiltInCategory.OST_FireAlarmDevices
+        ),
+    'Lighting devices': Taggable(
+        tag_type=DB.BuiltInCategory.OST_LightingDeviceTags,
+        element_type=DB.BuiltInCategory.OST_LightingDevices
+        ),
+    'Lighting fixtures': Taggable(
+        tag_type=DB.BuiltInCategory.OST_LightingFixtureTags,
+        element_type=DB.BuiltInCategory.OST_LightingFixtures
+        ),
+    'Nurse call devices': Taggable(
+        tag_type=DB.BuiltInCategory.OST_NurseCallDeviceTags,
+        element_type=DB.BuiltInCategory.OST_NurseCallDevices
+        ),
+    'Pipe accessories': Taggable(
+        tag_type=DB.BuiltInCategory.OST_PipeAccessoryTags,
+        element_type=DB.BuiltInCategory.OST_PipeAccessory
+        ),
+    'Plumbing equipment': Taggable(
+        tag_type=DB.BuiltInCategory.OST_PlumbingFixtureTags,
+        element_type=DB.BuiltInCategory.OST_PlumbingFixtures
+        ),
+    'Plumbing fixtures': Taggable(
+        tag_type=DB.BuiltInCategory.OST_PlumbingFixtureTags,
+        element_type=DB.BuiltInCategory.OST_PlumbingFixtures
+        ),
+    'Security devices': Taggable(
+        tag_type=DB.BuiltInCategory.OST_SecurityDeviceTags,
+        element_type=DB.BuiltInCategory.OST_SecurityDevices
+        ),
+        'Sprinklers': Taggable(
+            tag_type=DB.BuiltInCategory.OST_SprinklerTags,
+            element_type=DB.BuiltInCategory.OST_Sprinklers
+            ),
+    'Telephone devices': Taggable(
+        tag_type=DB.BuiltInCategory.OST_TelephoneDeviceTags,
+        element_type=DB.BuiltInCategory.OST_TelephoneDevices
+        ),
 }
 
 selected_switch = \

pyrevitlib/pyrevit/forms/__init__.py

@@ -2756,7 +2756,7 @@ def alert(msg, title=None, sub_msg=None, expanded=None, footer='',
     Args:
         msg (str): message to be displayed
         title (str, optional): task dialog title
-        sub_msg (str, optional): sub message
+        sub_msg (str, optional): sub message, use html to create clickable links
         expanded (str, optional): expanded area message
         footer (str, optional): footer text
         ok (bool, optional): show OK button, defaults to True
@@ -2774,6 +2774,7 @@ def alert(msg, title=None, sub_msg=None, expanded=None, footer='',
     Examples:
         >>> from pyrevit import forms
         >>> forms.alert('Are you sure?',
+                         sub_msg='<a href=\"https://discourse.pyrevitlabs.io/ \">Click here if you are not sure and want to go to the pyRevit Forum</a>'
         ...              ok=False, yes=True, no=True, exitscript=True)
     """
     # BUILD DIALOG

pyrevitlib/pyrevit/loader/uimaker.py

@@ -147,7 +147,7 @@ def _produce_ui_separator(ui_maker_params):
         mlogger.debug('Adding separator to: %s', parent_ui_item)
         try:
             if hasattr(parent_ui_item, 'add_separator'):    # re issue #361
-                parent_ui_item.z()
+                parent_ui_item.add_separator()
         except PyRevitException as err:
             mlogger.error('UI error: %s', err.msg)
 

pyrevitlib/pyrevit/runtime/InvokableDLLEngine.cs

@@ -9,9 +9,6 @@
 
 namespace PyRevitLabs.PyRevit.Runtime {
     public class InvokableDLLEngine : ScriptEngine {
-        private string scriptSig = string.Empty;
-        private Assembly scriptAssm = null;
-
         public override void Init(ref ScriptRuntime runtime) {
             base.Init(ref runtime);
 
@@ -39,19 +36,15 @@ public override int Execute(ref ScriptRuntime runtime) {
                         className = parts[1];
                     }
 
-                    var currentSig = CommonUtils.GetFileSignature(assmFile);
-                    if (scriptSig == null || currentSig != scriptSig) {
-                        scriptAssm = Assembly.Load(File.ReadAllBytes(assmFile));
-                        scriptSig = currentSig;
-                    }
 
+                    Assembly scriptAssm = Assembly.Load(File.ReadAllBytes(assmFile));
                     var resultCode = CLREngine.ExecuteExternalCommand(scriptAssm, className, ref runtime);
                     if (resultCode == ScriptExecutorResultCodes.ExternalInterfaceNotImplementedException)
                         TaskDialog.Show(PyRevitLabsConsts.ProductName,
                             string.Format(
                                 "Can not find type \"{0}\" in assembly \"{1}\"",
                                 className,
-                                scriptAssm.Location
+                                assmFile
                                 ));
                     return resultCode;
                 }